Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.

Commit

Permalink
Document prebuild and explain different compile steps
Browse files Browse the repository at this point in the history
  • Loading branch information
ralphtheninja committed Sep 8, 2015
1 parent b57840e commit 8b8c29e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
```

<a name="license"></a>
License &amp; copyright
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"scripts": {
"install": "prebuild --download",
"test": "tape test/*-test.js | faucet",
"rebuild": "prebuild --compile",
"prebuild": "prebuild --verbose --strip"
},
"license": "MIT",
Expand Down

0 comments on commit 8b8c29e

Please sign in to comment.