summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorit33 <iantien@gmail.com>2015-06-15 18:46:05 -0700
committerit33 <iantien@gmail.com>2015-06-15 18:46:05 -0700
commit7cb2bf8d809d60e97372762ec2933c63a63ca39a (patch)
treedefd70b7e3bdff77caf664b30f52687e50fd6e1f /README.md
parent4662ce929c7f2db24cdb3807437b39b15e793147 (diff)
downloadchat-7cb2bf8d809d60e97372762ec2933c63a63ca39a.tar.gz
chat-7cb2bf8d809d60e97372762ec2933c63a63ca39a.tar.bz2
chat-7cb2bf8d809d60e97372762ec2933c63a63ca39a.zip
Update README.md
Adding preamble, taking out boiler plate instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md60
1 files changed, 29 insertions, 31 deletions
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 `<Docker IP> 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