Skip to content

Commit

Permalink
Merge pull request #321 from chef/nls/native-linux-notes
Browse files Browse the repository at this point in the history
Merged change 852cb3b6-ed00-4f58-86e2-e8d08a8cf1aa

From review branch nls/native-linux-notes into master

Signed-off-by: smith <[email protected]>
  • Loading branch information
chef-delivery committed Mar 25, 2016
2 parents 95c5109 + a817a4d commit 1f6c0f2
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ by having a convention cover it. When we do need to configure things, we set san
* [Wikibook: Bourne Shell Scripting](https://en.wikibooks.org/wiki/Bourne_Shell_Scripting)
* [What is the difference between test, \[ and \[\[ ?](http://mywiki.wooledge.org/BashFAQ/031)

## Setup
## Setup On Mac OSX

1. [Install Docker Toolbox](http://docs.docker.com/mac/step_one/) (you'll need
at least Docker 1.9 and docker-machine 0.5. Both are included in Docker
Expand All @@ -111,6 +111,28 @@ Download the [delivery-cli
package](https://delivery-packages.s3.amazonaws.com/cli/deliverycli-20150819175041%2B20150819175041-1.pkg)),
install it, and you're done!

## Setup on native Linux

1. [Install Docker](https://docs.docker.com/linux/step_one/) **Note: You may need to logout and then login again after this step**
1. [Install Docker Compose](https://docs.docker.com/compose/install/)
1. Checkout the source by running `git clone [email protected]:chef/bldr.git; cd bldr`
1. Run `make build`
1. Run `make test`

Everything should come up green. Congratulations - you have a working Bldr development environment.

**Note:** The Makefile targets are documented. Run `make` or `make help` to show the output. Requires `perl`.

**Optional:** This project compiles and runs inside Docker containers so while installing the Rust language isn't strictly necessary, you might want a local copy of Rust on your workstation (some editors' language support require an installed version). To [install stable Rust](https://www.rust-lang.org/install.html), run: `curl -sSf https://static.rust-lang.org/rustup.sh | sh`

**Optional:** This project currently uses GitHub integration with Delivery so
while the delivery-cli tool is not strictly necessary to initiate reviews, it
is highly recommended to have installed for the other useful subcommands.
Download the [delivery-cli
package](https://delivery-packages.s3.amazonaws.com/cli/deliverycli-20150819175041%2B20150819175041-1.pkg)),
install it, and you're done!


## Documentation

Run `make docs` to build the internal documentation for bldr.
Expand Down

0 comments on commit 1f6c0f2

Please sign in to comment.