Skip to content

Commit

Permalink
docs: Extend go install tutorial.
Browse files Browse the repository at this point in the history
---------

Co-authored-by: norwnd <norwnd>
  • Loading branch information
norwnd authored Aug 26, 2023
1 parent 23cdbb9 commit 4de2581
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,17 @@ changes may be written to a config file in a platform-specific location:

## Build and installation

- **Install Go 1.19 or 1.20**
- **Install Go 1.19 or higher version**

Installation instructions can be found here: https://golang.org/doc/install.
Ensure Go was installed properly and is a supported version:
```sh
$ go version
$ go env GOROOT GOPATH
```
NOTE: `GOROOT` and `GOPATH` must not be on the same path. It is recommended
to add `$GOPATH/bin` to your `PATH` according to the Golang.org instructions.
NOTE: if `GOROOT` and `GOPATH` are initialized they must not be on the same path.
It is recommended to add `$GOPATH/bin` to your `PATH` according to the Golang.org
instructions.

- **Build or Update dcrctl**

Expand All @@ -59,6 +60,14 @@ changes may be written to a config file in a platform-specific location:
Alternatively, a development build can be performed by running `go install` in
a locally checked-out repository.

If you want to easily access `dcrctl` from the command-line without having to
type the full path to the binary every time, ensure the bin directory rooted
at the path reported by `go env GOPATH` is added to your system path:

* macOS: [how to add binary to your PATH](https://gist.github.com/nex3/c395b2f8fd4b02068be37c961301caa7#mac-os-x)
* Windows: [how to add binary to your PATH](https://gist.github.com/nex3/c395b2f8fd4b02068be37c961301caa7#windows)
* Linux and other Unix: [how to add binary to your PATH](https://gist.github.com/nex3/c395b2f8fd4b02068be37c961301caa7#linux)

## Developing

When developing either the `dcrd` or `dcrwallet` RPC servers and making
Expand Down

0 comments on commit 4de2581

Please sign in to comment.