Skip to content

Commit

Permalink
mimic CLI doc
Browse files Browse the repository at this point in the history
  • Loading branch information
felipemadero committed Nov 28, 2022
1 parent dff8a92 commit 064a7a8
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,21 @@ This tool may be especially useful for development and testing.

## Installation

To install the latest binary locally into `~/bin`, run:
To download a binary for the latest release, run:

```sh
curl -sSfL https://raw.githubusercontent.com/ava-labs/avalanche-network-runner/main/scripts/install.sh | sh -s
```

Add `~/bin` to the `$PATH` environment variable so the shell can find the `avalanche-network-runner` command:
The binary will be installed inside the `~/bin` directory.

To add the binary to your path, run

```sh
export PATH=$PATH:~/bin
export PATH=~/bin:$PATH
```

To have the shell always find the command, add that same `export` line to the
shell initialization script (`~/.bashrc` for the `bash` shell).
To add it to your path permanently, add an export command to your shell initialization script (ex: .bashrc).

## Build from source code

Expand All @@ -44,12 +45,12 @@ From inside the cloned directory:
./scripts/build.sh
```

After that, `avalanche-network-runner` binary should be present under the `./bin` directory, inside the cloned one.
The binary will be installed inside the `./bin` directory.

Add `./bin` to the `$PATH` environment variable so the shell can find the `avalanche-network-runner` command:
To add the binary to your path, run

```sh
export PATH=$PATH:$PWD/bin
export PATH=$PWD/bin:$PATH
```

### Run Unit Tests
Expand Down

0 comments on commit 064a7a8

Please sign in to comment.