mirror of
https://github.com/kemko/nomad.git
synced 2026-01-05 01:45:44 +03:00
add note about using Vagrant file to the README
This commit is contained in:
18
README.md
18
README.md
@@ -59,6 +59,24 @@ If you wish to work on Nomad itself or any of its built-in systems,
|
||||
you'll first need [Go](https://www.golang.org) installed on your
|
||||
machine (version 1.4+ is *required*).
|
||||
|
||||
**Developing with Vagrant**
|
||||
There is an included Vagrantfile that can help bootstrap the process. The
|
||||
created virtual machine is based off of Ubuntu 14, and installs several of the
|
||||
base libraries that can be used by Nomad.
|
||||
|
||||
To use this virtual machine, checkout Nomad and run `vagrant up` from the root
|
||||
of the repository:
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/hashicorp/nomad.git
|
||||
$ cd nomad
|
||||
$ vagrant up
|
||||
```
|
||||
|
||||
The virtual machine will launch, and a provisioning script will install the
|
||||
needed dependencies.
|
||||
|
||||
**Developing locally**
|
||||
For local dev first make sure Go is properly installed, including setting up a
|
||||
[GOPATH](https://golang.org/doc/code.html#GOPATH). After setting up Go, you can
|
||||
download the required build tools such as vet, cover, godep etc by bootstrapping
|
||||
|
||||
Reference in New Issue
Block a user