Jianwei Han / my-boxen

Download as
Browse Code ยป

Commit 70e99fcbffdfb93866ea820b13c4a081c08cdfed

Authored by Will Farrington
1 parent 0cbf6a884b

Add customization docs to README

Showing 1 changed file with 32 additions and 0 deletions Side-by-side Diff

... ... @@ -11,4 +11,36 @@
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.
12 12 5. `cd` to that dir and run `script/boxen`
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 +
  43 +For organization projects (read: repositories that people will be working in), please see the documentation in the projects module template we provide.
  44 +
  45 +For per-user configuration that doesn't need to be applied globally to everyone, please see the documentation in the people module template we provide.