Jianwei Han / my-boxen

Download as
Browse Code ยป

Commit 78d709d093db9f1f91ffeb796c8f26b586a8a5a6

Authored by Josh Nichols
1 parent 6e1bd53216

Add note about agreeing to XCode license.

Showing 1 changed file with 1 additions and 0 deletions Inline Diff

# 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.
The Boxen rubygem and the Boxen puppet modules are only a framework for getting 5 5 The Boxen rubygem and the Boxen puppet modules are only a framework for getting
things done. 6 6 things done.
This repository template is just a basic example of _how_ to do things with them. 7 7 This repository template is just a basic example of _how_ to do things with them.
8 8
## Getting Started 9 9 ## Getting Started
10 10
1. Install XCode Command Line Tools and/or full XCode. 11 11 1. Install XCode Command Line Tools and/or full XCode.
12 * If using full XCode, you'll need to agree to the license by running: `xcodebuild -license`
1. Create a new repository on GitHub as your user for your Boxen. (eg. 12 13 1. Create a new repository on GitHub as your user for your Boxen. (eg.
`wfarr/my-boxen`). **Make sure it is a private repository!** 13 14 `wfarr/my-boxen`). **Make sure it is a private repository!**
1. Get running like so: 14 15 1. Get running like so:
``` 15 16 ```
mkdir -p ~/src/my-boxen 16 17 mkdir -p ~/src/my-boxen
cd ~/src/my-boxen 17 18 cd ~/src/my-boxen
git init 18 19 git init
git remote add upstream https://github.com/boxen/our-boxen 19 20 git remote add upstream https://github.com/boxen/our-boxen
git fetch upstream 20 21 git fetch upstream
git co -b master upstream/master 21 22 git co -b master upstream/master
git remote add origin https://github.com/wfarr/my-boxen 22 23 git remote add origin https://github.com/wfarr/my-boxen
git push origin master 23 24 git push origin master
24 25
script/boxen 25 26 script/boxen
``` 26 27 ```
1. Close and reopen your Terminal. If you have a shell config file 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: 28 29 (eg. `~/.bashrc`) you'll need to add this at the very end:
`[ -f /opt/boxen/env.sh ] && source /opt/boxen/env.sh`, and reload 29 30 `[ -f /opt/boxen/env.sh ] && source /opt/boxen/env.sh`, and reload
your shell. 30 31 your shell.
1. Confirm the Boxen env has loaded: `boxen --env` 31 32 1. Confirm the Boxen env has loaded: `boxen --env`
32 33
Now you have your own my-boxen repo that you can hack on. 33 34 Now you have your own my-boxen repo that you can hack on.
You may have noticed we didn't ask you to fork the repo. 34 35 You may have noticed we didn't ask you to fork the repo.
This is because when our-boxen goes open source that'd have some 35 36 This is because when our-boxen goes open source that'd have some
implications about your fork also potentially being public. 36 37 implications about your fork also potentially being public.
That's obviously quite bad, so that's why we strongly suggest you 37 38 That's obviously quite bad, so that's why we strongly suggest you
create an entirely separate repo and simply pull the code in, as shown above. 38 39 create an entirely separate repo and simply pull the code in, as shown above.
39 40
## What You Get 40 41 ## What You Get
41 42
This template project provides the following by default: 42 43 This template project provides the following by default:
43 44
* Homebrew 44 45 * Homebrew
* Git 45 46 * Git
* Hub 46 47 * Hub
* DNSMasq w/ .dev resolver for localhost 47 48 * DNSMasq w/ .dev resolver for localhost
* NVM 48 49 * NVM
* RBenv 49 50 * RBenv
* Full Disk Encryption requirement 50 51 * Full Disk Encryption requirement
* NodeJS 0.4 51 52 * NodeJS 0.4
* NodeJS 0.6 52 53 * NodeJS 0.6
* NodeJS 0.8 53 54 * NodeJS 0.8
* Ruby 1.8.7 54 55 * Ruby 1.8.7
* Ruby 1.9.2 55 56 * Ruby 1.9.2
* Ruby 1.9.3 56 57 * Ruby 1.9.3
* Ack 57 58 * Ack
* Findutils 58 59 * Findutils
* GNU-Tar 59 60 * GNU-Tar
60 61
## Customizing 61 62 ## Customizing
62 63
You can always check out the number of existing modules we already 63 64 You can always check out the number of existing modules we already
provide as optional installs under the 64 65 provide as optional installs under the
[boxen organization](https://github.com/boxen). These modules are all 65 66 [boxen organization](https://github.com/boxen). These modules are all
tested to be compatible with Boxen. Use the `Puppetfile` to pull them 66 67 tested to be compatible with Boxen. Use the `Puppetfile` to pull them
in dependencies automatically whenever `boxen` is run. You'll have to 67 68 in dependencies automatically whenever `boxen` is run. You'll have to
make sure your "node" (Puppet's term for your laptop, basically) 68 69 make sure your "node" (Puppet's term for your laptop, basically)
includes or requires them. You can do this by either modifying 69 70 includes or requires them. You can do this by either modifying