Skip to content

Commit

Permalink
docs: add GOBIN disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
MegaRedHand committed Jan 21, 2025
1 parent cb04270 commit 4553e72
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,6 @@ Also, only contracts inside foundry projects are supported as of now.

For development, we require [the `go` toolchain to be installed](https://go.dev/doc/install).

> [!IMPORTANT]
> To be able to [install the CLI via `go`](#installation), you'll need to add `$HOME/go/bin` to your `PATH`.
> You can do so by adding to your `~/.bashrc` (or the equivalent for your shell) the following line:
>
> ```bash
> export PATH="$PATH:$HOME/go/bin"
> ```
## How to install

### Using `go` toolchain
Expand All @@ -37,6 +29,16 @@ To install the devnet using the `go` toolchain:
go install github.com/Layr-Labs/avs-devnet/cmd/avs-devnet
```

> [!IMPORTANT]
> To be able to use the CLI when installed via `go`, you'll need to add `GOBIN` (by default `$HOME/go/bin`) to your `PATH`.
> You can do so by adding to your `~/.bashrc`, or the equivalent for your shell, the following line:
>
> ```bash
> export PATH="$PATH:$HOME/go/bin"
> ```
>
> More information [on the Go wiki](https://go.dev/wiki/GOPATH).
### With a local copy of the repo
To build and install the CLI with a local copy of the repo, first clone the repo, and then run:
Expand Down

0 comments on commit 4553e72

Please sign in to comment.