summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorit33 <iantien@gmail.com>2015-06-16 08:24:55 -0700
committerit33 <iantien@gmail.com>2015-06-16 08:24:55 -0700
commit332c3a0fd10bc27ccaa174738a7cbdb0ad6c967b (patch)
tree8a934c403cab020ec5e178162f90ab361226ceee
parent9c660eb6b942f1302ff41855a66f228082734eb1 (diff)
downloadchat-332c3a0fd10bc27ccaa174738a7cbdb0ad6c967b.tar.gz
chat-332c3a0fd10bc27ccaa174738a7cbdb0ad6c967b.tar.bz2
chat-332c3a0fd10bc27ccaa174738a7cbdb0ad6c967b.zip
Reducing number of steps in Mattermost Setup
-rw-r--r--README.md23
1 files changed, 10 insertions, 13 deletions
diff --git a/README.md b/README.md
index 612b38dd7..396accee6 100644
--- a/README.md
+++ b/README.md
@@ -23,8 +23,9 @@ Developer Machine Setup (Mac)
DOCKER
-1. Follow the instructions at http://docs.docker.com/installation/mac/ Use the Boot2Docker command-line utility
-If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”`
+1. Follow the instructions at http://docs.docker.com/installation/mac/
+<br>a) Use the Boot2Docker command-line utility
+<br>b) If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”`
2. Get your Docker IP address with `boot2docker ip`
3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost`
4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile
@@ -47,17 +48,13 @@ COMPASS SETUP
MATTERMOST SETUP
-1. Make a project directory for Mattermost, which will for the rest of this document be referred to as $PROJECT
-2. Make a go directory in your $PROJECT directory
-3. Create/Open your ~/.bash_profile and add the following lines: `export GOPATH=$PROJECT/go export PATH=$PATH:$GOPATH/bin`
-4. Refresh your bash profile with `source ~/.bash_profile`
-5. `cd $GOPATH`
-6. `mkdir -p src/github.com/mattermost` then cd into this directory
-7. `git clone github.com/mattermost/platform.git`
-8. If you do not have Mercurial, download it with: `brew install mercurial`
-9. `cd platform`
-10. `make test`
-11. Provided the test runs fine, you now have a complete build environment. Use `make run` to run your code
+1. Make a project directory for Mattermost, which we'll call **$PROJECT** for the rest of these instructions
+2. Make a `go` directory in your $PROJECT directory
+3. Open or create your *~/.bash_profile* and add the following lines: <br>`export GOPATH=$PROJECT/go`<br>`export PATH=$PATH:$GOPATH/bin` <br>then refresh your bash profile with `source ~/.bash_profile`
+4. Then use `cd $GOPATH` and `mkdir -p src/github.com/mattermost` then cd into this directory and run `git clone github.com/mattermost/platform.git`
+5. If you do not have Mercurial, download it with: `brew install mercurial`
+6. Then do `cd platform` and `make test`. Provided the test runs fine, you now have a complete build environment.
+7. Use `make run` to run your code
Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul