From 7cb2bf8d809d60e97372762ec2933c63a63ca39a Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:46:05 -0700 Subject: Update README.md Adding preamble, taking out boiler plate instructions --- README.md | 60 +++++++++++++++++++++++++++++------------------------------- 1 file changed, 29 insertions(+), 31 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 920cabe79..8dbaf52ab 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,53 @@ +XXXXXX TODO: Test install procedures -XXXXXX - TODO someone needs to update +Mattermost (Preview) +Team Communication Service +Version 0.40 -Will become a heading -============== +What matters most to your team? +=============================== -Will become a sub heading --------------- +Words have power. We built Mattermost for teams who use words to shape the future. +The words you choose are up to you. -*This will be Italic* +*- SpinPunch* -**This will be Bold** +Installing the Mattermost Preview +================================= -- This will be a list item -- This will be a list item - - Add a indent and this will end up as code - - -See ---- -[http://daringfireball.net/projects/markdown/](http://daringfireball.net/projects/markdown/) -[http://en.wikipedia.org/wiki/Markdown](http://en.wikipedia.org/wiki/Markdown) -[http://github.github.com/github-flavored-markdown/](http://github.github.com/github-flavored-markdown/) +You're installing "Mattermost Preview", a pre-released version intended for an early look at what we're building. While SpinPunch runs this codebase internally, because your use will differ from ours this version is not recommended for production deployments. +That said, any issues at all, please let us know on our forum at: http://bit.ly/1MY1kul Developer Machine Setup (Mac) -============================= +----------------------------- -Docker Setup ------------- -1. Follow the instructions at docs.docker.com/installation/mac/ Use the Boot2Docker command-line utility +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)”` 2. Get your Docker ip address with `boot2docker ip` 3. Add a line to your /etc/hosts that goes ` dockerhost` 4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile -Go Setup --------- -1. Download Go from golang.org/dl/ +Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul + +GO + +1. Download Go from http://golang.org/dl/ + +NODE.JS SETUP -Node.js Setup -------------- 1. Install homebrew from brew.sh 2. `brew install node` -Compass Setup -------------- +COMPASS SETUP + 1. Make sure you have the latest version of Ruby 2. `gem install compass` -Mattermost 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` @@ -63,3 +60,4 @@ Mattermost Setup 10. `make test` 11. Provided the test runs fine, you now have a complete build environment. Use `make run` to run your code +Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul -- cgit v1.2.3-1-g7c22 From 0247f158a70853fe7af1f1227246e61285e2fbdc Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:48:43 -0700 Subject: Update README.md --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8dbaf52ab..ffb42247c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ XXXXXX TODO: Test install procedures -Mattermost (Preview) -Team Communication Service -Version 0.40 +Mattermost (Preview)
+Team Communication Service
+Version 0.40 -What matters most to your team? -=============================== +**What matters most to your team?** -Words have power. We built Mattermost for teams who use words to shape the future. +Words have power. We built Mattermost for teams who use words to shape the future.
The words you choose are up to you. *- SpinPunch* @@ -17,7 +16,7 @@ Installing the Mattermost Preview You're installing "Mattermost Preview", a pre-released version intended for an early look at what we're building. While SpinPunch runs this codebase internally, because your use will differ from ours this version is not recommended for production deployments. -That said, any issues at all, please let us know on our forum at: http://bit.ly/1MY1kul +That said, any issues at all, please let us know on the Mattermost forum at: http://bit.ly/1MY1kul Developer Machine Setup (Mac) ----------------------------- -- cgit v1.2.3-1-g7c22 From a4a125d1d0013c61b2745ddbe47f0b422466e7af Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:56:09 -0700 Subject: Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ffb42247c..b5c92aec3 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,11 @@ Mattermost (Preview)
Team Communication Service
Version 0.40 -**What matters most to your team?** +What matters most to your team? +=============================== -Words have power. We built Mattermost for teams who use words to shape the future.
+Words have power.
+We built Mattermost for teams who use words to shape the future.
The words you choose are up to you. *- SpinPunch* -- cgit v1.2.3-1-g7c22 From 7bfccca5c5db8c3488f4dd1f83f6aac6b8ba2fe9 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:59:45 -0700 Subject: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b5c92aec3..29b82f549 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -XXXXXX TODO: Test install procedures - Mattermost (Preview)
Team Communication Service
Version 0.40 @@ -62,3 +60,5 @@ MATTERMOST SETUP 11. Provided the test runs fine, you now have a complete build environment. Use `make run` to run your code Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul + +XXXXXX TODO: Test install procedures -- cgit v1.2.3-1-g7c22 From 5ac1fbe0850ed7b2bca71b66806fecb4cf092de5 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:03:00 -0700 Subject: Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 29b82f549..81e1d21bf 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -Mattermost (Preview)
-Team Communication Service
-Version 0.40 +**Mattermost (Preview)
** +**Team Communication Service
** +**Version 0.40** What matters most to your team? =============================== Words have power.
-We built Mattermost for teams who use words to shape the future.
+Mattermost serves teams who use words to shape the future.
The words you choose are up to you. *- SpinPunch* @@ -61,4 +61,4 @@ MATTERMOST SETUP Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul -XXXXXX TODO: Test install procedures +**XXXXXX TODO: Test install procedures** -- cgit v1.2.3-1-g7c22 From 1365c52597544c4e5f801f21c8b1292f1b9ee412 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:07:36 -0700 Subject: Fix typo, "ip" should be "IP" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 81e1d21bf..a7913ed8d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ 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)”` -2. Get your Docker ip address with `boot2docker ip` +2. Get your Docker IP address with `boot2docker ip` 3. Add a line to your /etc/hosts that goes ` dockerhost` 4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile -- cgit v1.2.3-1-g7c22 From 7bfed5246420d476f05015c6a993649738817206 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:11:58 -0700 Subject: Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a7913ed8d..b47e0c0f0 100644 --- a/README.md +++ b/README.md @@ -61,4 +61,8 @@ MATTERMOST SETUP Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul +License +------- + +Mattermost uses the Apache 2.0 open source license: http://bit.ly/1Lc25Sv **XXXXXX TODO: Test install procedures** -- cgit v1.2.3-1-g7c22 From 5fc8a175a362badd55ebd2eddc45fa054408684e Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:12:35 -0700 Subject: Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index b47e0c0f0..d7b246d79 100644 --- a/README.md +++ b/README.md @@ -64,5 +64,6 @@ Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul License ------- -Mattermost uses the Apache 2.0 open source license: http://bit.ly/1Lc25Sv +Mattermost uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv
+ **XXXXXX TODO: Test install procedures** -- cgit v1.2.3-1-g7c22 From f162fb12678723580794c45fa40552f410402762 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:15:10 -0700 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d7b246d79..e64ab0374 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,6 @@ Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul License ------- -Mattermost uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv
+Mattermost Preview uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv
**XXXXXX TODO: Test install procedures** -- cgit v1.2.3-1-g7c22 From 50a968927fdce4c1f7cb3d8f83d4a401af98515e Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 05:22:44 -0700 Subject: More caveats in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e64ab0374..0676b8903 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The words you choose are up to you. Installing the Mattermost Preview ================================= -You're installing "Mattermost Preview", a pre-released version intended for an early look at what we're building. While SpinPunch runs this codebase internally, because your use will differ from ours this version is not recommended for production deployments. +You're installing "Mattermost Preview", a pre-released 0.40 version intended for an early look at what we're building. While SpinPunch runs this version internally, it's not recommended for production deployments since we can't guarantee API stability or backwards compatibility until our 1.0 version release. That said, any issues at all, please let us know on the Mattermost forum at: http://bit.ly/1MY1kul -- cgit v1.2.3-1-g7c22 From 96179f5867301a9dafc3a76800860b5860190103 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 07:57:54 -0700 Subject: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0676b8903..612b38dd7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -**Mattermost (Preview)
** +**Mattermost Preview
** **Team Communication Service
** **Version 0.40** @@ -64,6 +64,6 @@ Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul License ------- -Mattermost Preview uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv
+This software uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv
**XXXXXX TODO: Test install procedures** -- cgit v1.2.3-1-g7c22 From e8fc27b248906dd1e32a965bd22697aaf43bd8c0 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 08:24:55 -0700 Subject: Reducing number of steps in Mattermost Setup --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) (limited to 'README.md') 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/ +
a) Use the Boot2Docker command-line utility +
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 ` 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:
`export GOPATH=$PROJECT/go`
`export PATH=$PATH:$GOPATH/bin`
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 -- cgit v1.2.3-1-g7c22 From d8049860b4b14fdf1f5e67b167d93d6b5c98bcb9 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 08:28:56 -0700 Subject: Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 396accee6..706d4daad 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ That said, any issues at all, please let us know on the Mattermost forum at: htt Developer Machine Setup (Mac) ----------------------------- -DOCKER +DOCKER SETUP 1. Follow the instructions at http://docs.docker.com/installation/mac/
a) Use the Boot2Docker command-line utility @@ -32,7 +32,7 @@ DOCKER Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul -GO +GO SETUP 1. Download Go from http://golang.org/dl/ @@ -50,7 +50,7 @@ MATTERMOST SETUP 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:
`export GOPATH=$PROJECT/go`
`export PATH=$PATH:$GOPATH/bin`
then refresh your bash profile with `source ~/.bash_profile` +3. Open or create your ~/.bash_profile and add the following lines:
`export GOPATH=$PROJECT/go`
`export PATH=$PATH:$GOPATH/bin`
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. -- cgit v1.2.3-1-g7c22 From 4b478f55c2ab57c9acd2bcd07f4fd6e1344a2cb3 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 08:40:45 -0700 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 706d4daad..c3e844f61 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ GO SETUP NODE.JS SETUP -1. Install homebrew from brew.sh +1. Install homebrew from http://brew.sh 2. `brew install node` COMPASS SETUP -- cgit v1.2.3-1-g7c22