Merge pull request #2 from mattermost/master

to me
This commit is contained in:
Reed Garmsen
2015-06-16 09:13:07 -07:00
3 changed files with 51 additions and 51 deletions

View File

@@ -1,5 +0,0 @@
XXXXXX - TODO
someone needs to update

4
NOTICE.txt Normal file
View File

@@ -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/

View File

@@ -1,65 +1,66 @@
**Mattermost Preview<br>**
**Team Communication Service<br>**
**Version 0.40**
XXXXXX - TODO someone needs to update What matters most to your team?
===============================
Will become a heading Words have power.<br>
============== Mattermost serves teams who use words to shape the future.<br>
The words you choose are up to you.
Will become a sub heading *- SpinPunch*
--------------
*This will be Italic* Installing the Mattermost Preview
=================================
**This will be Bold** 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.
- 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/)
That said, any issues at all, please let us know on the Mattermost forum at: http://bit.ly/1MY1kul
Developer Machine Setup (Mac) Developer Machine Setup (Mac)
============================= -----------------------------
Docker Setup DOCKER SETUP
------------
1. Follow the instructions at docs.docker.com/installation/mac/ Use the Boot2Docker command-line utility 1. Follow the instructions at http://docs.docker.com/installation/mac/
If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”` <br>a) Use the Boot2Docker command-line utility
2. Get your Docker ip address with `boot2docker ip` <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` 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 4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile
Go Setup Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul
--------
1. Download Go from golang.org/dl/
Node.js Setup GO SETUP
-------------
1. Install homebrew from brew.sh 1. Download Go from http://golang.org/dl/
NODE.JS SETUP
1. Install homebrew from http://brew.sh
2. `brew install node` 2. `brew install node`
Compass Setup COMPASS SETUP
-------------
1. Make sure you have the latest version of Ruby 1. Make sure you have the latest version of Ruby
2. `gem install compass` 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`
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
License
-------
This software uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv<br>
**XXXXXX TODO: Test install procedures**