Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
- link to our website
- link to our install guide
- remove out-of-date quickstart
- instructions for devs on how to put the binaries in the correct place
  • Loading branch information
ramfox committed Nov 1, 2022
1 parent 8a876fe commit bd68e48
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 101 deletions.
18 changes: 17 additions & 1 deletion DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ machine:

#### Protobuf compiler

[Protobuf compiler](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation): Download it from the [Protobuf Releases page](https://github.com/protocolbuffers/protobuf/releases); you need to get the `protoc-` release for your platform. To install, make sure the `protoc` compiler is on your path. If you get errors during build about `experimental_allow_proto3_optional` or inability to import `/google/protobuf/empty.proto` you're likely using a version of the compiler that's too old.
[Protobuf compiler](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation): Download it from the [Protobuf Releases page](https://github.com/protocolbuffers/protobuf/releases)

You need to get the `protoc-` release for your platform (they can be found at the very bottom of the list of release binaries). To install, make sure the `protoc` compiler is on your path. If you get errors during build about `experimental_allow_proto3_optional` or inability to import `/google/protobuf/empty.proto` you're likely using a version of the compiler that's too old.

It may be that Rust Analyzer does not find the protobuf compiler even after installation. You can point it in the right direction using a configuration like this:

Expand Down Expand Up @@ -58,6 +60,20 @@ $ cargo run -p iroh-store
$ cargo run -p iroh -- status --watch
```

If you want to use the `iroh` binary to start and stop the services, you can
use `xtask` to move previously built binaries to the correct bin:

```shell
# build the binaries
$ cargo build

# or build the binaries for release:
$ cargo build --release

# move the binaries to the correct location
$ cargo xtask dev-install
```

## <a name="rules"></a> Coding Rules

When you push your branch to github and open up a pull request, it will automatically trigger [CircleCI](https://circleci.com/about/) to lint and test your code.
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,7 @@ This repo is a common core for three distributions of iroh:
- **Iroh One:** A select set of iroh cloud features packaged as a single binary for simplified deployment.
- **Iroh Mobile:** iOS & Android libraries that bring efficient data distribution to mobile apps.

## Project Status: Early Days

Iroh has yet to publish a release. We are targeting the end of October 2022 for an initial version, which will coincide with the launch of a proper web site & documentation. Before iroh's first release we're in build-from-source and read-source-to-understand-how-it-works territory.

In the meantime, there's a [quickstart guide](./quickstart.md) if you'd like to get a feel for running an iroh cloud gateway.
Here is an [install guide](https://iroh.computer/install).

## Working on Iroh
Check out the [CONTRIBUTOR docs](./CONTRIBUTOR.md) to get familiar with ways you can contribute to the Iroh project. The [DEVELOPERS docs](./DEVELOPERS.md) will help you get starting with building and developing Iroh.
Expand All @@ -25,7 +21,7 @@ A full suite of automated benchmarks is in the works. [this talk](https://www.yo

## Who's behind this?

Iroh is built & maintained by [number 0](https://n0.computer). We're a founder-backed startup hell-bent on building efficient distributed systems software.
[Iroh](https://iroh.computer) is built & maintained by [number 0](https://n0.computer). We're a founder-backed startup hell-bent on building efficient distributed systems software.

## License

Expand Down
94 changes: 0 additions & 94 deletions quickstart.md

This file was deleted.

0 comments on commit bd68e48

Please sign in to comment.