Add documentation for contributors

README.md

@@ -1,6 +1,6 @@
-mermaid [![Build Status](https://travis-ci.org/knsv/mermaid.svg?branch=master)](https://travis-ci.org/knsv/mermaid) [![Code Climate](https://codeclimate.com/github/knsv/mermaid/badges/gpa.svg)](https://codeclimate.com/github/knsv/mermaid)
+# mermaid [![Build Status](https://travis-ci.org/knsv/mermaid.svg?branch=master)](https://travis-ci.org/knsv/mermaid)
-=======
 
+[![Code Climate](https://codeclimate.com/github/knsv/mermaid/badges/gpa.svg)](https://codeclimate.com/github/knsv/mermaid)
 [![Join the chat at https://gitter.im/knsv/mermaid](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/knsv/mermaid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Generation of diagrams and flowcharts from text in a similar manner as markdown.
@@ -108,6 +108,7 @@ end
 
 </table>
 
+
 ## Further reading
 
 * [Usage](http://knsv.github.io/mermaid/#usage)
@@ -116,6 +117,7 @@ end
 * [Mermaid client](http://knsv.github.io/mermaid/#mermaid-cli)
 * [Demos](http://knsv.github.io/mermaid/#demos)
 
+
 # Request for assistance
 
 Things are piling up and I have hard time keeping up. To remedy this
@@ -134,11 +136,50 @@ Together we could continue the work with things like:
 
 Don't hesitate to contact me if you want to get involved.
 
+
+# For contributors
+
+## Setup
+
+Make sure you have Chrome browser installed, this project uses Chrome headless to running tests.
+
+    yarn install
+
+
+## Build
+
+    yarn build
+
+If you want real time incremental build:
+
+    yarn watch
+
+
+## Lint
+
+    yarn lint
+
+We use [JavaScript Standard Style](https://github.com/feross/standard).
+We recommend you installing [editor plugins](https://github.com/feross/standard#are-there-text-editor-plugins) so you can get real time lint result.
+
+
+## Test
+
+    yarn test
+
+
+## Distribtion
+
+    yarn dist
+
+Command above generates files into the `dist` folder, then you can publish them to npmjs.org.
+
+
 # Credits
-Many thanks to the [d3](http://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing
+
-the graphical layout and drawing libraries! Thanks also to the
+Many thanks to the [d3](http://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!
-[js-sequence-diagram](http://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the
+
-sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering.
+Thanks also to the [js-sequence-diagram](http://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering.
 
 *Mermaid was created by Knut Sveidqvist for easier documentation.*
 

todo.md

@@ -14,3 +14,4 @@
         - need to remove it after upgrading to d3 v4
 - use headless chrome provided by karma-chrome-launcher
     - https://github.com/karma-runner/karma-chrome-launcher
+- rewrite live editor