rename DEVELOPING.md to CONTRIBUTING.md - refs #424

mapbox · Jun 20, 2016 · 317be69 · 317be69
1 parent e780899
commit 317be69
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/DEVELOPING.md → CONTRIBUTING.MD b/DEVELOPING.md → CONTRIBUTING.MD
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+## Developing
+
+Installing:
+
+    git clone https://github.com/mapbox/carto.git
+    cd carto
+    npm install
+
+Test:
+
+    npm test
+
+Running the head binary:
+
+    ./bin/carto
+
+## Documentation
+
+This repository contains auto-generated documentation of the content of Carto
+that's published on Mapbox.com.
+
+    git fetch origin gh-pages:gh-pages
+
+Edit `_docs/package.json` to point to the head version of [mapnik-reference](https://github.com/mapnik/mapnik-reference).
+
+    cd _docs
+    npm install
+    node generate.js
+
+Then run up a directory and run the testing server:
+
+    cd ../
+    jekyll serve -p 4000
+
+Test the new site at `localhost:4000/carto` and if things look good then git add your changes and push.