Commit 38a27ec9cb03ac0c3386f61749721a83ec93149b

Authored by Will Farrington
1 parent 83f69fe91e

README tweaks

Showing 2 changed files with 4 additions and 1 deletions Inline Diff

system 1 1 1.8.7
2 2
# 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 The Boxen rubygem and the Boxen puppet modules are only a framework for getting
6 things done.
7 This repository template is just a basic example of _how_ to do things with them.
5 8
## Getting Started 6 9 ## Getting Started
7 10
1. Fork this repository. 8 11 1. Fork this repository.
2. Modify the `Puppetfile` and `modules/` to your heart's content. 9 12 2. Modify the `Puppetfile` and `modules/` to your heart's content.
3. Get a copy of your fork somewhere locally. 10 13 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 14 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 15 5. `cd` to that dir and run `script/boxen`
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. 13 16 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.
7. Open a new shell. 14 17 7. Open a new shell.
8. Verify `boxen --env` prints out `BOXEN_` env vars. 15 18 8. Verify `boxen --env` prints out `BOXEN_` env vars.
9. Rock out. :metal: 16 19 9. Rock out. :metal:
17 20
## What You Get 18 21 ## What You Get
19 22
This template project provides the following by default: 20 23 This template project provides the following by default:
21 24
* Homebrew 22 25 * Homebrew
* Git 23 26 * Git
* Hub 24 27 * Hub
* DNSMasq w/ .dev resolver for localhost 25 28 * DNSMasq w/ .dev resolver for localhost
* NVM 26 29 * NVM
* RBenv 27 30 * RBenv
* Full Disk Encryption requirement 28 31 * Full Disk Encryption requirement
* NodeJS 0.4 29 32 * NodeJS 0.4
* NodeJS 0.6 30 33 * NodeJS 0.6
* NodeJS 0.8 31 34 * NodeJS 0.8
* Ruby 1.8.7 32 35 * Ruby 1.8.7
* Ruby 1.9.2 33 36 * Ruby 1.9.2
* Ruby 1.9.3 34 37 * Ruby 1.9.3
* Ack 35 38 * Ack
* Findutils 36 39 * Findutils
* GNU-Tar 37 40 * GNU-Tar