Commit 4d1599b1677e52668aa653fa3bc00e9b65bf77bc
1 parent
6e1bd53216
Update git command in README
Even though a lot of people setup `git co`, it's not available on a fresh install. Makes copy-pasta for creating my-boxen easier.
Showing 1 changed file with 1 additions and 1 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. | |
| 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. | |
| 1. Create a new repository on GitHub as your user for your Boxen. (eg. | 12 | 12 | 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 | 13 | `wfarr/my-boxen`). **Make sure it is a private repository!** | |
| 1. Get running like so: | 14 | 14 | 1. Get running like so: | |
| ``` | 15 | 15 | ``` | |
| mkdir -p ~/src/my-boxen | 16 | 16 | mkdir -p ~/src/my-boxen | |
| cd ~/src/my-boxen | 17 | 17 | cd ~/src/my-boxen | |
| git init | 18 | 18 | git init | |
| git remote add upstream https://github.com/boxen/our-boxen | 19 | 19 | git remote add upstream https://github.com/boxen/our-boxen | |
| git fetch upstream | 20 | 20 | git fetch upstream | |
| git co -b master upstream/master | 21 | 21 | git checkout -b master upstream/master | |
| git remote add origin https://github.com/wfarr/my-boxen | 22 | 22 | git remote add origin https://github.com/wfarr/my-boxen | |
| git push origin master | 23 | 23 | git push origin master | |
| 24 | 24 | |||
| script/boxen | 25 | 25 | script/boxen | |
| ``` | 26 | 26 | ``` | |
| 1. Close and reopen your Terminal. If you have a shell config file | 27 | 27 | 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 | 28 | (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 | 29 | `[ -f /opt/boxen/env.sh ] && source /opt/boxen/env.sh`, and reload | |
| your shell. | 30 | 30 | your shell. | |
| 1. Confirm the Boxen env has loaded: `boxen --env` | 31 | 31 | 1. Confirm the Boxen env has loaded: `boxen --env` | |
| 32 | 32 | |||
| Now you have your own my-boxen repo that you can hack on. | 33 | 33 | 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 | 34 | 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 | 35 | This is because when our-boxen goes open source that'd have some | |
| implications about your fork also potentially being public. | 36 | 36 | implications about your fork also potentially being public. | |
| That's obviously quite bad, so that's why we strongly suggest you | 37 | 37 | 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 | 38 | create an entirely separate repo and simply pull the code in, as shown above. | |
| 39 | 39 | |||
| ## What You Get | 40 | 40 | ## What You Get | |
| 41 | 41 | |||
| This template project provides the following by default: | 42 | 42 | This template project provides the following by default: | |
| 43 | 43 | |||
| * Homebrew | 44 | 44 | * Homebrew | |
| * Git | 45 | 45 | * Git | |
| * Hub | 46 | 46 | * Hub | |
| * DNSMasq w/ .dev resolver for localhost | 47 | 47 | * DNSMasq w/ .dev resolver for localhost | |
| * NVM | 48 | 48 | * NVM | |
| * RBenv | 49 | 49 | * RBenv | |
| * Full Disk Encryption requirement | 50 | 50 | * Full Disk Encryption requirement | |
| * NodeJS 0.4 | 51 | 51 | * NodeJS 0.4 | |
| * NodeJS 0.6 | 52 | 52 | * NodeJS 0.6 | |
| * NodeJS 0.8 | 53 | 53 | * NodeJS 0.8 | |
| * Ruby 1.8.7 | 54 | 54 | * Ruby 1.8.7 | |
| * Ruby 1.9.2 | 55 | 55 | * Ruby 1.9.2 | |
| * Ruby 1.9.3 | 56 | 56 | * Ruby 1.9.3 | |
| * Ack | 57 | 57 | * Ack | |
| * Findutils | 58 | 58 | * Findutils | |
| * GNU-Tar | 59 | 59 | * GNU-Tar | |
| 60 | 60 | |||
| ## Customizing | 61 | 61 | ## Customizing | |
| 62 | 62 | |||
| You can always check out the number of existing modules we already | 63 | 63 | You can always check out the number of existing modules we already | |
| provide as optional installs under the | 64 | 64 | provide as optional installs under the | |
| [boxen organization](https://github.com/boxen). These modules are all | 65 | 65 | [boxen organization](https://github.com/boxen). These modules are all | |
| tested to be compatible with Boxen. Use the `Puppetfile` to pull them | 66 | 66 | tested to be compatible with Boxen. Use the `Puppetfile` to pull them | |
| in dependencies automatically whenever `boxen` is run. You'll have to | 67 | 67 | in dependencies automatically whenever `boxen` is run. You'll have to | |
| make sure your "node" (Puppet's term for your laptop, basically) | 68 | 68 | make sure your "node" (Puppet's term for your laptop, basically) | |
| includes or requires them. You can do this by either modifying | 69 | 69 | includes or requires them. You can do this by either modifying | |
| `manifests/site.pp` for each module, _or_ we would generally recommend | 70 | 70 | `manifests/site.pp` for each module, _or_ we would generally recommend |