Jianwei Han / my-boxen

Download as
Browse Code ยป

Commit 0bd729feb2b59fe2e549ab409ebdea69d80b6220

Authored by Will Farrington
1 parent 38a27ec9cb

README updates

Showing 1 changed file with 18 additions and 9 deletions Side-by-side Diff

... ... @@ -8,15 +8,24 @@
8 8  
9 9 ## Getting Started
10 10  
11   -1. Fork this repository.
12   -2. Modify the `Puppetfile` and `modules/` to your heart's content.
13   -3. Get a copy of your fork somewhere locally.
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.
15   -5. `cd` to that dir and run `script/boxen`
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.
17   -7. Open a new shell.
18   -8. Verify `boxen --env` prints out `BOXEN_` env vars.
19   -9. Rock out. :metal:
  11 +It's pretty important you follow these steps exactly.
  12 +You should not fork this repository for your organization's Boxen.
  13 +We have some pretty specific semantics about forking and public/private repositories.
  14 +We really recommend doing it this way:
  15 +
  16 +1. Create a new local git repository. Create a private repository on GitHub under your organization for your boxen (eg. `myorg/myorg-boxen`)
  17 +1. In your new repository, `git remote add upstream https://github.com/boxen/our-boxen && git fetch upstream && git co -b master upstream/master`
  18 +1. Now follow the directions GitHub gave you when creating your private copy to push the master branch to your private copy.
  19 +
  20 +With that done, now you can tweak it to your use:
  21 +
  22 +1. Modify the `Puppetfile` and `modules/` to your heart's content.
  23 +1. 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.
  24 +1. `cd` to that dir and run `script/boxen`
  25 +1. 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.
  26 +1. Open a new shell.
  27 +1. Verify `boxen --env` prints out `BOXEN_` env vars.
  28 +1. Rock out. :metal:
20 29  
21 30 ## What You Get
22 31