Files
MapLibreParticleLab/platform/node/DEVELOPING.md
Minh Nguyễn f8f735b574 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/.
2016-01-05 08:04:16 -08:00

1001 B
Raw Blame History

Developing the Mapbox GL Native Node.js module

This document explains how to build the Node.js 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 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, 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