Skip to content

Commit

Permalink
docs: add go install instructions (#190)
Browse files Browse the repository at this point in the history
Depends on #189

This PR adds another way of installing `avs-devnet`, with `go install`.
  • Loading branch information
MegaRedHand authored Jan 22, 2025
1 parent aaf434d commit 03229a8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,29 @@ 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).

## How to install

### Using `go` toolchain

To install the devnet using the `go` toolchain:

```sh
go install github.com/Layr-Labs/avs-devnet/cmd/avs-devnet
```

> [!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:
> 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).
## Installation
### With a local copy of the repo
To build and install the CLI locally, run:
To build and install the CLI with a local copy of the repo, first clone the repo, and then run:
```sh
make deps # installs dependencies
Expand Down
2 changes: 1 addition & 1 deletion src/cmds/flags/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import "github.com/urfave/cli/v2"
// TODO: move to constants.
//
//nolint:gochecknoglobals // this is a constant
var DefaultKurtosisPackage string = ""
var DefaultKurtosisPackage string = "github.com/Layr-Labs/avs-devnet/kurtosis_package"

//nolint:gochecknoglobals // these are constants
var (
Expand Down

0 comments on commit 03229a8

Please sign in to comment.