From 16ae3163667af64c1dd7fd0cd21c78c322934ac0 Mon Sep 17 00:00:00 2001 From: Will Farrington Date: Wed, 17 Oct 2012 18:12:17 -0700 Subject: [PATCH] add docs about how to have members of your org set things up --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index e516d21..c024fad 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,24 @@ implications about your fork also potentially being public. 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. +## Getting your users started _after_ your "fork" exists + +1. Install the XCode Command Line Tools (full XCode install optional). +1. Run the following: + +``` +sudo mkdir -p /opt/boxen +sudo chown $USER:admin /opt/boxen +git clone https://github.com/yourorg/yourreponame.git /opt/boxen/repo +cd /opt/boxen/repo +script/boxen + +# add boxen to your shell config, at the end, eg. +echo '[ -f /opt/boxen/env.sh ] && source /opt/boxen/env.sh' +``` + +Open a new terminal, `boxen --env` to confirm. + ## What You Get This template project provides the following by default: -- 1.8.5.3