summaryrefslogtreecommitdiff
path: root/node_modules/node-addon-api/doc/prebuild_tools.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/node-addon-api/doc/prebuild_tools.md')
-rw-r--r--node_modules/node-addon-api/doc/prebuild_tools.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/node_modules/node-addon-api/doc/prebuild_tools.md b/node_modules/node-addon-api/doc/prebuild_tools.md
new file mode 100644
index 0000000..573af68
--- /dev/null
+++ b/node_modules/node-addon-api/doc/prebuild_tools.md
@@ -0,0 +1,16 @@
+# Prebuild tools
+
+The distribution of a native add-on is just as important as its implementation.
+In order to install a native add-on it's important to have all the necessary
+dependencies installed and well configured (see the [setup](setup.md) section).
+The end-user will need to compile the add-on when they will do an `npm install`
+and in some cases this could create problems. To avoid the compilation process it's
+possible to ditribute the native add-on in pre-built form for different platform
+and architectures. The prebuild tools help to create and distrubute the pre-built
+form of a native add-on.
+
+The following list report known tools that are compatible with **N-API**:
+
+- **[node-pre-gyp](https://www.npmjs.com/package/node-pre-gyp)**
+- **[prebuild](https://www.npmjs.com/package/prebuild)**
+- **[prebuildify](https://www.npmjs.com/package/prebuildify)**