diff options
author | Minh Nguyễn <mxn@1ec5.org> | 2015-12-24 17:19:59 -0800 |
---|---|---|
committer | Minh Nguyễn <mxn@1ec5.org> | 2016-01-05 08:04:16 -0800 |
commit | f8f735b5745051e94cf4f527a5b33b09825bc86d (patch) | |
tree | deaf202a6b0230de1fe4689a48002d5fabac558a /platform/node/DEVELOPING.md | |
parent | 6af69e4e56628a7a330a7cedf9233e724bd9e344 (diff) | |
download | qtlocation-mapboxgl-f8f735b5745051e94cf4f527a5b33b09825bc86d.tar.gz |
Rewrote documentation
Rewrote some copy to provide more context and link to more GL-related repos, including GL JS. Put the various SDKs in a table so we can show the various CI bot status images.
Integrated target list into the relevant documents. Rewrote large portions of iOS and OS X setup documentation to guide normal developers to more friendly places. Combined some Android documentation.
Moved SDK-specific documentation into platform/. Added a temporary readme in ios/ that points to the one in platform/ios/.
Diffstat (limited to 'platform/node/DEVELOPING.md')
-rw-r--r-- | platform/node/DEVELOPING.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/platform/node/DEVELOPING.md b/platform/node/DEVELOPING.md new file mode 100644 index 0000000000..cd03fa6ca3 --- /dev/null +++ b/platform/node/DEVELOPING.md @@ -0,0 +1,29 @@ +# Developing the Mapbox GL Native Node.js module + +This document explains how to build the [Node.js](https://nodejs.org/) bindings for [../../README.md](Mapbox GL Native) for contributing to the development of the bindings themselves. If you just want to use the module, you can simply install it via `npm`; see [README.md](README.md) for installation and usage instructions. + +## Building + +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](../../INSTALL.md), 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 +``` |