Commit 83f69fe91e0f165aead620973016ad624783dc1f

Authored by Will Farrington
1 parent 011f08e42b

Update README

Showing 1 changed file with 5 additions and 2 deletions Inline Diff

# Our Boxen 1 1 # Our Boxen
2 2
This is a template Boxen project designed for your organization to fork and 3 3 This is a template Boxen project designed for your organization to fork and
modify appropriately. 4 4 modify appropriately.
5 5
## Getting Started 6 6 ## Getting Started
7 7
1. Fork this repository. 8 8 1. Fork this repository.
2. Modify the `Puppetfile` and `modules/` to your heart's content. 9 9 2. Modify the `Puppetfile` and `modules/` to your heart's content.
3. Get a copy of your fork somewhere locally. 10 10 3. Get a copy of your fork somewhere locally.
4. Install the XCode Command Line Tools package. You need an Apple ID. We know. It sucks. You can thank Apple for not allowing the Command Line Tools to be redistributed publicly. 11 11 4. Install the XCode Command Line Tools package. You need an Apple ID. We know. It sucks. You can thank Apple for not allowing the Command Line Tools to be redistributed publicly.
5. `cd` to that dir and run `script/boxen` 12 12 5. `cd` to that dir and run `script/boxen`
6. Rock out. :metal: 13 13 6. Ensure you have `[ -f /opt/boxen/env.sh ] && source /opt/boxen/env.sh` in your shell config. If you don't have a shell config yet, we automatically add this to `~/.profile` for you.
14 7. Open a new shell.
15 8. Verify `boxen --env` prints out `BOXEN_` env vars.
16 9. Rock out. :metal:
14 17
## What You Get 15 18 ## What You Get
16 19
This template project provides the following by default: 17 20 This template project provides the following by default:
18 21
* Homebrew 19 22 * Homebrew
* Git 20 23 * Git
* Hub 21 24 * Hub
* DNSMasq w/ .dev resolver for localhost 22 25 * DNSMasq w/ .dev resolver for localhost
* NVM 23 26 * NVM
* RBenv 24 27 * RBenv
* Full Disk Encryption requirement 25 28 * Full Disk Encryption requirement
* NodeJS 0.4 26 29 * NodeJS 0.4
* NodeJS 0.6 27 30 * NodeJS 0.6
* NodeJS 0.8 28 31 * NodeJS 0.8
* Ruby 1.8.7 29 32 * Ruby 1.8.7
* Ruby 1.9.2 30 33 * Ruby 1.9.2
* Ruby 1.9.3 31 34 * Ruby 1.9.3
* Ack 32 35 * Ack
* Findutils 33 36 * Findutils
* GNU-Tar 34 37 * GNU-Tar
35 38