Skip to content

Commit

Permalink
docs: improve installing instructions (Closes #123)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt committed May 11, 2024
1 parent 634e755 commit 76df36e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ It uses the least modules possible and is intended to be used as a starting poin

In addition to learn how to build a chain thanks to `minid`, you can as well directly run `minid`.

### Prerequisites

* Install Go as described [here](https://go.dev/doc/install).
* Add `GOPATH` to your `PATH`:
* `export PATH="$PATH:/usr/local/go/bin:$(/usr/local/go/bin/go env GOPATH)/bin"`

You are all set!

### Installation

Install and run `minid`:
Expand All @@ -21,6 +29,11 @@ make init # initialize the chain
minid start # start the chain
```

### Troubleshoot

After running `make install`, verify `minid` has been installed by doing `which minid`.
If `minid` is not found, verify that your `$PATH` is configured correctly.

## Useful links

* [Cosmos-SDK Documentation](https://docs.cosmos.network/)

0 comments on commit 76df36e

Please sign in to comment.