add docs about how to have members of your org set things up
This commit is contained in:
parent
78dd9c6176
commit
16ae316366
1 changed files with 18 additions and 0 deletions
18
README.md
18
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
|
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.
|
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
|
## What You Get
|
||||||
|
|
||||||
This template project provides the following by default:
|
This template project provides the following by default:
|
||||||
|
|
Loading…
Reference in a new issue