Jianwei Han / my-boxen

Download as
Browse Code ยป

Commit a0281788e6d03577c550b960c50b9e3725b543df

Authored by Will Farrington
1 parent 947c2af4e0

README tweaks

Showing 1 changed file with 35 additions and 19 deletions Side-by-side Diff

... ... @@ -8,24 +8,32 @@
8 8  
9 9 ## Getting Started
10 10  
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:
  11 +1. Install XCode Command Line Tools and/or full XCode.
  12 +1. Create a new repository on GitHub as your user for your Boxen. (eg.
  13 +`wfarr/my-boxen`). **Make sure it is a private repository!** for now
  14 +1. Get running like so:
15 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.
  16 +```
  17 +mkdir -p ~/src/my-boxen
  18 +cd ~/src/my-boxen
  19 +git init
  20 +git remote add upstream https://github.com/boxen/our-boxen
  21 +git fetch upstream
  22 +git co -b master upstream/master
  23 +git remote add origin https://github.com/wfarr/my-boxen
  24 +git push origin master
19 25  
20   -With that done, now you can tweak it to your use:
  26 +script/boxen
  27 +```
  28 +1. Close and reopen your Terminal. If you have a shell config file (eg. `~/.bashrc`) you'll need to add this at the very end: `[ -f /opt/boxen/env.sh ] && source /opt/boxen/env.sh`,
  29 +1. Confirm the Boxen env has loaded: `boxen --env`
21 30  
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:
  31 +Now you have your own my-boxen repo that you can hack on.
  32 +You may have noticed we didn't ask you to fork the repo.
  33 +This is because when our-boxen goes open source that'd have some
  34 +implications about your fork also potentially being public.
  35 +That's obviously quite bad, so that's why we strongly suggest you
  36 +create an entirely separate repo and simply pull the code in, as shown above.
29 37  
30 38 ## What You Get
31 39  
... ... @@ -50,10 +58,18 @@
50 58  
51 59 ## Customizing
52 60  
53   -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`.
54   -
55   -For your organization, it's recommended you create a module to contain the configuration in the `modules/` directory (eg. `modules/github`).
56   -Then, you simply need to include that module in `manifests/site.pp`.
  61 +You can always check out the number of existing modules we already
  62 +provide as optional installs under the
  63 +[boxen organization](https://github.com/boxen). These modules are all
  64 +tested to be compatible with Boxen. Use the `Puppetfile` to pull them
  65 +in dependencies automatically whenever `boxen` is run. You'll have to
  66 +make sure your "node" (Puppet's term for your laptop, basically)
  67 +includes or requires them. You can do this by either modifying
  68 +`manifests/site.pp` for each module, _or_ we would generally recommend
  69 +you create a module for your organization (eg. `modules/github`) and
  70 +create an environment class in that. Then you need only adjust
  71 +`manifests/site.pp` by doing `include github::environment` or
  72 +what-have-you for your organization.
57 73  
58 74 For organization projects (read: repositories that people will be working in), please see the documentation in the projects module template we provide.
59 75