Skip to content

Commit

Permalink
docs: install prebuilt binaries (#162)
Browse files Browse the repository at this point in the history
Rework CLI Installation documentation to tell users where to download
the release binaries of `zinnia` we are building for them.

Remove the mention of the no longer needed `protoc` dependency.

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>
  • Loading branch information
bajtos committed Mar 30, 2023
1 parent 2917acb commit 2038a9f
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,26 @@ executable.

## Installation

To install Zinnia, you need to have Rust tooling installed on your machine. See
[Install Rust](https://www.rust-lang.org/tools/install).
You can download the `zinnia` binary from
[our GitHub Releases](https://github.com/filecoin-station/zinnia/releases/latest).

You also need the Protocol Buffers compiler, `protoc`. See
[Protocol Buffer Compiler Installation](https://grpc.io/docs/protoc-installation/)
| OS | Platform | Filename |
| ------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- |
| Windows | Intel, 64bit | [zinnia-windows-x64.zip](https://github.com/filecoin-station/zinnia/releases/latest/download/zinnia-windows-x64.zip) |
| macOS | Intel, 64bit | [zinnia-macos-x64.zip](https://github.com/filecoin-station/zinnia/releases/latest/download/zinnia-macos-x64.zip) |
| macOS | Apple Silicon | [zinnia-macos-arm64.zip](https://github.com/filecoin-station/zinnia/releases/latest/download/zinnia-macos-arm64.zip) |
| Linux | Intel, 64bit | [zinnia-linux-x64.tar.gz](https://github.com/filecoin-station/zinnia/releases/latest/download/zinnia-linux-x64.tar.gz) |

Then you can install Zinnia using `cargo`:
### Build from source

If you have Rust tooling installed on your machine (see
[Install Rust](https://www.rust-lang.org/tools/install)), you can build & install Zinnia from the
source code.

```sh
$ cargo install zinnia
```

This will build Zinnia and all its dependencies from source, which can take a while. In the future,
we want to simplify the installation process, see
[#23](https://github.com/filecoin-station/zinnia/issues/23).

## Basic use

### Run a JavaScript module
Expand Down

0 comments on commit 2038a9f

Please sign in to comment.