summaryrefslogtreecommitdiff
path: root/docs/DEVELOP_NODE.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/DEVELOP_NODE.md')
-rw-r--r--docs/DEVELOP_NODE.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/DEVELOP_NODE.md b/docs/DEVELOP_NODE.md
new file mode 100644
index 0000000000..7422a40a08
--- /dev/null
+++ b/docs/DEVELOP_NODE.md
@@ -0,0 +1,34 @@
+# Developing the Mapbox GL Native Node Module
+
+**Just want to use the module? You can install it via npm without doing any of
+this:**
+```
+npm install mapbox-gl-native
+```
+
+This repository contains the bindings from the C++ core of Mapbox GL Native
+to [Node.js](https://nodejs.org/). To develop these bindings,
+you'll need to build them from source. Building requires installing all of the basic
+dependencies needed for Mapbox GL Native, then running:
+
+ npm install --build-from-source
+
+From the root directory. This will compile the Node.js bindings and install module dependencies.
+
+To recompile just the C++ code while developing, run `make node`.
+
+To create an Xcode project and use a GUI debugger in the case of a crash, run `make xnode`.
+
+## Testing
+
+To test the Node.js bindings:
+
+```
+npm test
+```
+
+To run the visual render test suite:
+
+```
+npm run test-suite
+```