doc: Simplify README #9378
doc: Simplify README #9378
Conversation
This is mostly switching paragraphs to bullets to make following instructions easier. In doing so, this also adds instructions to install things that were previously assumed to be installed, like Vagrant, Virtualbox, and Consul. It also removes the expectation that Nomad is cloned to $GOPATH, as that is not necessary.
| 1. Compile a development binary (see the [UI README](https://github.com/hashicorp/nomad/blob/master/ui/README.md) to include the web UI in the binary) | ||
| ```sh | ||
| $ make dev | ||
| # find the built binary at ./bin/nomad |
There was a problem hiding this comment.
It looks like this path is coming from the previous version of the directions, but I think it ends up at ~/go/bin/nomad by default?
There was a problem hiding this comment.
It gets installed to multiple places by default:
./bin/nomad./pkg/$GOOS_$GOARCH/nomad$GOPATH/bin/nomad
See https://github.com/hashicorp/nomad/blob/master/GNUmakefile#L288.
There's no real need for it to be installed into $GOPATH/bin, except that people may be depending on $GOPATH/bin having been added to their $PATH as a way to run a dev build.
There was a problem hiding this comment.
Oh? (Rummages around on file system) 🤦 sure does, doesn't it! LGTM
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
This is mostly switching paragraphs to bullets to make following
instructions easier. In doing so, this also adds instructions to install
things that were previously assumed to be installed, like Vagrant,
Virtualbox, and Consul.
It also removes the expectation that Nomad is cloned to $GOPATH, as that
is not necessary.