diff options
| author | John Firebaugh <john.firebaugh@gmail.com> | 2018-04-29 15:27:49 -0700 |
|---|---|---|
| committer | John Firebaugh <john.firebaugh@gmail.com> | 2018-04-30 13:10:31 -0700 |
| commit | 9a4b806fa84bd3d2d1adb57eae4f9fdb5f79d9f9 (patch) | |
| tree | 9f5272734dcca3d00cc24fc2dba4f5bfc904f5f7 /platform/node | |
| parent | 65a4ee2373d053ac5b8d179123fdc51b320a1bb7 (diff) | |
| download | qtlocation-mapboxgl-9a4b806fa84bd3d2d1adb57eae4f9fdb5f79d9f9.tar.gz | |
[docs] Make per-platform installation docs self-contained
I've seen several issues where users followed platform-specific install docs, but were unaware of additional prerequisites spelled out in the top-level INSTALL.md. So let's try making each platform's installation documentation self contained.
Diffstat (limited to 'platform/node')
| -rw-r--r-- | platform/node/DEVELOPING.md | 8 | ||||
| -rw-r--r-- | platform/node/README.md | 3 |
2 files changed, 7 insertions, 4 deletions
diff --git a/platform/node/DEVELOPING.md b/platform/node/DEVELOPING.md index b313d75c13..215b06c7bf 100644 --- a/platform/node/DEVELOPING.md +++ b/platform/node/DEVELOPING.md @@ -4,11 +4,13 @@ This document explains how to build the [Node.js](https://nodejs.org/) bindings ## 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: +To develop these bindings, you’ll need to build them from source. Building requires the prerequisites listed in either +the [macOS](../macos/INSTALL.md#requirements) or [Linux](../linux/README.md#prerequisites) install documentation, depending +on the target platform. - npm install --build-from-source +To compile the Node.js bindings and install module dependencies, from the repository root directory, run: -From the root directory. This will compile the Node.js bindings and install module dependencies. + npm install --build-from-source To recompile just the C++ code while developing, run `make node`. diff --git a/platform/node/README.md b/platform/node/README.md index d19b2a9343..ac5bcd7e8d 100644 --- a/platform/node/README.md +++ b/platform/node/README.md @@ -17,7 +17,8 @@ Run: npm install @mapbox/mapbox-gl-native ``` -Other platforms will fall back to a source compile with `make node`; see INSTALL.md in the repository root directory for prequisites. +Other platforms will fall back to a source compile with `make node`; see [DEVELOPING.md](DEVELOPING.md) for details on +building from source. ## Testing |