Commit 70e99fcbffdfb93866ea820b13c4a081c08cdfed
1 parent
0cbf6a884b
Add customization docs to README
Showing 1 changed file with 32 additions and 0 deletions Inline Diff
README.md
| # 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. Rock out. :metal: | |
| 14 | ||||
| 15 | ## What You Get | |||
| 16 | ||||
| 17 | This template project provides the following by default: | |||
| 18 | ||||
| 19 | * Homebrew | |||
| 20 | * Git | |||
| 21 | * Hub | |||
| 22 | * DNSMasq w/ .dev resolver for localhost | |||
| 23 | * NVM | |||
| 24 | * RBenv | |||
| 25 | * Full Disk Encryption requirement | |||
| 26 | * NodeJS 0.4 | |||
| 27 | * NodeJS 0.6 | |||
| 28 | * NodeJS 0.8 | |||
| 29 | * Ruby 1.8.7 | |||
| 30 | * Ruby 1.9.2 | |||
| 31 | * Ruby 1.9.3 | |||
| 32 | * Ack | |||
| 33 | * Findutils | |||
| 34 | * GNU-Tar | |||
| 35 | ||||
| 36 | ## Customizing | |||
| 37 | ||||
| 38 | You can always check out the number of existing modules we already provide as optional installs under the [boxen organization](https://github.com/boxen). These modules are all tested to be compatible with Boxen. You can include these modules by modifying the Puppetfile, adding them to `manifests/site.pp` if they should be installed on every machine, and then running `boxen`. | |||
| 39 | ||||
| 40 | For your organization, it's recommended you create a module to contain the configuration in the `modules/` directory (eg. `modules/github`). | |||
| 41 | Then, you simply need to include that module in `manifests/site.pp`. | |||
| 42 |