From 8b8c29e14711607e7d28e93316058b2c02258874 Mon Sep 17 00:00:00 2001 From: Lars-Magnus Skog Date: Tue, 8 Sep 2015 03:04:22 +0200 Subject: [PATCH] Document prebuild and explain different compile steps --- README.md | 14 +++++++++++++- package.json | 1 + 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6af6a89f..4d43a80d 100644 --- a/README.md +++ b/README.md @@ -307,7 +307,19 @@ A large portion of the Windows support comes from code by [Krzysztof Kowalczyk]( Prebuilt binaries ----------------- -LevelDOWN uses `node-pre-gyp` to support prebuilt binaries. For a list of supported prebuilt platform binaries see https://github.com/Level/leveldown/releases +LevelDOWN uses `prebuild` to support prebuilt binaries. See [this list](https://github.com/Level/leveldown/releases) of supported prebuilt platform binaries. When installing LevelDOWN `prebuild --download` will download prebuilt binaries from GitHub if they exist and fallback to a compile step if they don't. + +If you are working on LevelDOWN and want to compile the C++ code you can do: + +``` +$ npm run rebuild [--debug] [--verbose] +``` + +or + +``` +$ npm i --build-from-source [--debug] [--verbose] +``` License & copyright diff --git a/package.json b/package.json index 1306e2d8..f334453f 100644 --- a/package.json +++ b/package.json @@ -51,6 +51,7 @@ "scripts": { "install": "prebuild --download", "test": "tape test/*-test.js | faucet", + "rebuild": "prebuild --compile", "prebuild": "prebuild --verbose --strip" }, "license": "MIT",