Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document new platform support and prebuilt binaries #558

Merged
merged 3 commits into from
Dec 16, 2018
Merged

Document new platform support and prebuilt binaries #558

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
125135f
document new platform support and prebuilt binaries
vweevers Dec 16, 2018
5b5463a
Fix typo
ralphtheninja Dec 16, 2018
c00c573
revert strikethrough
vweevers Dec 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,19 @@ See the section on <a href="#safety">safety</a> below for details of known unsaf

## Supported Platforms

We aim to support *at least* Active LTS and Current Node.js releases. `leveldown` ships with prebuilt binaries for [many platforms](https://github.com/Level/leveldown/releases) and is known to work on:
We aim to support *at least* Active LTS and Current Node.js releases, as well as any future Node.js release thanks to [N-API](https://nodejs.org/api/n-api.html). Because N-API has an experimental status in node 6 and early 8.x releases, the minimum node version for `leveldown` is `8.6.0`.

The `leveldown` npm package ships with prebuilt binaries for popular 64-bit platforms and is known to work on:
vweevers marked this conversation as resolved.
Show resolved Hide resolved

* **Linux** (including ARM platforms such as Raspberry Pi *and Kindle!*)
* **Mac OS**
* **Solaris** (SmartOS & Nodejitsu)
* **FreeBSD**
* **Windows**

When installing `leveldown`, [`prebuild-install`](https://github.com/prebuild/prebuild-install) will install prebuilt binaries from GitHub if they exist and fallback to a compile step if they don't. In that case you'll need a [valid `node-gyp` installation](https://github.com/nodejs/node-gyp#installation).
When installing `leveldown`, [`node-gyp-build`](https://github.com/mafintosh/node-gyp-build) will check if a compatible binary exists and fallback to a compile step it it doesn't. In that case you'll need a [valid `node-gyp` installation](https://github.com/nodejs/node-gyp#installation).
vweevers marked this conversation as resolved.
Show resolved Hide resolved

If you don't want to use the prebuilt binary for the platform you are installing on, specify the `--build-from-source` flag when you install. If you are working on `leveldown` itself and want to re-compile the C++ code it's enough to do `npm install`.
~~If you don't want to use the prebuilt binary for the platform you are installing on, specify the `--build-from-source` flag when you install.~~ If you are working on `leveldown` itself and want to re-compile the C++ code it's enough to do `npm install`.
vweevers marked this conversation as resolved.
Show resolved Hide resolved

## API

Expand Down