Skip to content

Commit e96afaf

Browse files
author
Dane Springmeyer
committed
Merge pull request TryGhost#174 from Mithgol/patch-1
create “INSTALLING” section in README for the most simple instructions
2 parents a754951 + 9f4bb8c commit e96afaf

1 file changed

Lines changed: 19 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,27 @@ db.close();
5050
See the [API documentation](https://github.com/developmentseed/node-sqlite3/wiki) in the wiki.
5151

5252

53+
# INSTALLING
54+
55+
You can use [`npm`](https://github.com/isaacs/npm) to download and install:
56+
57+
* The latest `sqlite3` package: `npm install sqlite`
58+
59+
* GitHub's `master` branch: `npm install https://github.com/developmentseed/node-sqlite3/tarball/master`
60+
61+
In both cases the module is automatically built with npm's internal version of `node-gyp`,
62+
and thus your system must meet [node-gyp's requirements](https://github.com/TooTallNate/node-gyp#installation).
63+
64+
You can also make your own build of `sqlite3` from the source (see the next section for details).
65+
66+
5367
# BUILDING
5468

55-
Unless building via `npm install` you will need `node-gyp` installed globally:
69+
Unless building via `npm install` (which uses its own `node-gyp`) you will need `node-gyp` installed globally:
5670

5771
npm install node-gyp -g
5872

59-
The module depends only on libsqlite3. However, by default, an internal/bundled copy of sqlite will be built and statically linked, so an externally installed sqlite3 is not required.
73+
The sqlite3 module depends only on libsqlite3. However, by default, an internal/bundled copy of sqlite will be built and statically linked, so an externally installed sqlite3 is not required.
6074

6175
If you wish to install against an external sqlite then you need to pass the `--sqlite` argument to `node-gyp`, `npm install` or the `configure` wrapper.
6276

@@ -79,21 +93,13 @@ Note, if building against homebrew-installed sqlite on OS X you can do:
7993
./configure --sqlite=/usr/local/opt/sqlite/
8094
make
8195

82-
To obtain and build the bindings:
83-
84-
git clone git://github.com/developmentseed/node-sqlite3.git
85-
cd node-sqlite3
86-
npm install
87-
88-
You can also use [`npm`](https://github.com/isaacs/npm) to download and install them:
8996

90-
npm install sqlite3
91-
92-
93-
# TESTS
97+
# TESTING
9498

9599
[mocha](https://github.com/visionmedia/mocha) is required to run unit tests.
96100

101+
In sqlite3's directory (where its `package.json` resides) run the following:
102+
97103
npm install mocha
98104
npm test
99105

0 commit comments

Comments
 (0)