more readme love

This commit is contained in:
Will Farrington 2012-10-09 09:45:16 -10:00
parent a0281788e6
commit 553c2e33d0

View file

@ -12,20 +12,22 @@ This repository template is just a basic example of _how_ to do things with them
1. Create a new repository on GitHub as your user for your Boxen. (eg. 1. Create a new repository on GitHub as your user for your Boxen. (eg.
`wfarr/my-boxen`). **Make sure it is a private repository!** for now `wfarr/my-boxen`). **Make sure it is a private repository!** for now
1. Get running like so: 1. Get running like so:
```
``` mkdir -p ~/src/my-boxen
mkdir -p ~/src/my-boxen cd ~/src/my-boxen
cd ~/src/my-boxen git init
git init git remote add upstream https://github.com/boxen/our-boxen
git remote add upstream https://github.com/boxen/our-boxen git fetch upstream
git fetch upstream git co -b master upstream/master
git co -b master upstream/master git remote add origin https://github.com/wfarr/my-boxen
git remote add origin https://github.com/wfarr/my-boxen git push origin master
git push origin master
script/boxen
script/boxen ```
``` 1. Close and reopen your Terminal. If you have a shell config file
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`, (eg. `~/.bashrc`) you'll need to add this at the very end:
`[ -f /opt/boxen/env.sh ] && source /opt/boxen/env.sh`, and reload
your shell.
1. Confirm the Boxen env has loaded: `boxen --env` 1. Confirm the Boxen env has loaded: `boxen --env`
Now you have your own my-boxen repo that you can hack on. Now you have your own my-boxen repo that you can hack on.