GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Knut Sveidqvist 2014-12-03 17:28:21 +01:00
parent 0539b8a74e
commit c0e9638109
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -46,4 +46,23 @@ Never prepend "/images/" when using image_path or image_tag.
Also for the CDN, always use cwd-relative paths rather than root-relative paths in image URLs in any CSS. So instead of
url('/images/blah.gif'), use url('../images/blah.gif').
# Build instructions
Fork, then:
```
npm install
```
Then the dependencies will have been installed. You use gulp as build tool.
The following targets are probably interesting:
* jison - compiles the jison grammars to parser files
* jasmine - runs the jasmine tests (will trigger the jison target)
* dist - complies files to the dist catalog
for instance:
```
gulp jasmine
```
Thanks, Knut Sveidqvist