From 3dbffe3492af36d256ef58083e48223c43b41283 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 17:04:08 -0700 Subject: [PATCH 01/17] Update LICENSE.txt to Apache 2.0 --- License.txt | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 License.txt diff --git a/License.txt b/License.txt deleted file mode 100644 index 6abd425dd0..0000000000 --- a/License.txt +++ /dev/null @@ -1,5 +0,0 @@ - - -XXXXXX - TODO - -someone needs to update \ No newline at end of file From 53072256cf85e566d3c5a3474b86289a49813b3d Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 17:15:57 -0700 Subject: [PATCH 02/17] Create NOTICES.txt XXXXXX TODO: Replace sample text with references to 3rd party libraries used --- NOTICES.txt | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 NOTICES.txt diff --git a/NOTICES.txt b/NOTICES.txt new file mode 100644 index 0000000000..07c6a8bf4f --- /dev/null +++ b/NOTICES.txt @@ -0,0 +1,4 @@ +Mattermost Platform Preview +Copyright 2015 SpinPunch, Inc. + +Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/ From 4662ce929c7f2db24cdb3807437b39b15e793147 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 17:18:39 -0700 Subject: [PATCH 03/17] Rename NOTICES.txt to NOTICE.txt --- NOTICES.txt => NOTICE.txt | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename NOTICES.txt => NOTICE.txt (100%) diff --git a/NOTICES.txt b/NOTICE.txt similarity index 100% rename from NOTICES.txt rename to NOTICE.txt From 7cb2bf8d809d60e97372762ec2933c63a63ca39a Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:46:05 -0700 Subject: [PATCH 04/17] Update README.md Adding preamble, taking out boiler plate instructions --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 920cabe794..8dbaf52ab3 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 From 0247f158a70853fe7af1f1227246e61285e2fbdc Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:48:43 -0700 Subject: [PATCH 05/17] Update README.md --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8dbaf52ab3..ffb42247c3 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) ----------------------------- From a4a125d1d0013c61b2745ddbe47f0b422466e7af Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:56:09 -0700 Subject: [PATCH 06/17] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ffb42247c3..b5c92aec38 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* From 7bfccca5c5db8c3488f4dd1f83f6aac6b8ba2fe9 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 18:59:45 -0700 Subject: [PATCH 07/17] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b5c92aec38..29b82f549c 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 From 5ac1fbe0850ed7b2bca71b66806fecb4cf092de5 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:03:00 -0700 Subject: [PATCH 08/17] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 29b82f549c..81e1d21bfa 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** From 1365c52597544c4e5f801f21c8b1292f1b9ee412 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:07:36 -0700 Subject: [PATCH 09/17] Fix typo, "ip" should be "IP" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 81e1d21bfa..a7913ed8d0 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 From 7bfed5246420d476f05015c6a993649738817206 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:11:58 -0700 Subject: [PATCH 10/17] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a7913ed8d0..b47e0c0f01 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** From 5fc8a175a362badd55ebd2eddc45fa054408684e Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:12:35 -0700 Subject: [PATCH 11/17] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b47e0c0f01..d7b246d795 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** From f162fb12678723580794c45fa40552f410402762 Mon Sep 17 00:00:00 2001 From: it33 Date: Mon, 15 Jun 2015 19:15:10 -0700 Subject: [PATCH 12/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d7b246d795..e64ab03744 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** From 50a968927fdce4c1f7cb3d8f83d4a401af98515e Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 05:22:44 -0700 Subject: [PATCH 13/17] More caveats in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e64ab03744..0676b89033 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 From 96179f5867301a9dafc3a76800860b5860190103 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 07:57:54 -0700 Subject: [PATCH 14/17] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0676b89033..612b38dd7f 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** From e8fc27b248906dd1e32a965bd22697aaf43bd8c0 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 08:24:55 -0700 Subject: [PATCH 15/17] Reducing number of steps in Mattermost Setup --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 612b38dd7f..396accee6e 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 From d8049860b4b14fdf1f5e67b167d93d6b5c98bcb9 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 08:28:56 -0700 Subject: [PATCH 16/17] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 396accee6e..706d4daadf 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. From 4b478f55c2ab57c9acd2bcd07f4fd6e1344a2cb3 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 16 Jun 2015 08:40:45 -0700 Subject: [PATCH 17/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 706d4daadf..c3e844f611 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