Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README installation instructions #895

Merged
merged 5 commits into from
Jun 25, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,21 +59,30 @@ The following table lists all work streams and links to their home directory and
- Clone this repository
- Clone this repository's submodules:

```bash
git submodule update --init --recursive
```
```bash
git submodule update --init --recursive
```

### Install Dependencies

- Install [Go](https://golang.org/doc/install) (Flow supports Go 1.13 and later)
- Install [CMake](https://cmake.org/install/), which is used for building the crypto library
- Install [Docker](https://docs.docker.com/get-docker/), which is used for running
a local network and integration tests
- All remaining dependencies can be installed automatically:
- Make sure the [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable) and `GOBIN` environment variables are set, and `GOBIN` is added to your path:

```bash
make install-tools
```
```bash
export GOPATH=$(go env GOPATH)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will work the first run, but in general I think they will need to add this to their shell profile so it is persisted. Maybe we can add a note to do that as well and link to the docs

export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOBIN
```

Add these to your shell profile to persist them for future runs.
- Then, run the following command:

```bash
make install-tools
```

At this point, you should be ready to build, test, and run Flow! 🎉

Expand Down