Commit b7afe57
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -17,7 +17,7 @@ To run `nodegit2` you need `NodeJS` and to run unit tests you will need to have | |||
| 17 | 17 | ||
| 18 | 18 | ### Mac OS X/Linux/Unix ### | |
| 19 | 19 | ||
| 20 | - #### Install `nodegit2` by cloning source from __GitHub__ and running the `make` and `make install` commands. #### | ||
| 20 | + #### Install `nodegit2` by cloning source from __GitHub__ and running the `make` and `make install` commands: #### | ||
| 21 | 21 | ||
| 22 | 22 | [tim@thinkpad Projects]$ git clone git@github.com:tbranyen/nodegit2.git | |
| 23 | 23 | [tim@thinkpad Projects]$ cd nodegit2 | |
@@ -94,22 +94,15 @@ __ Accomplishing the same thing as above __ | |||
| 94 | 94 | Running tests | |
| 95 | 95 | ------------- | |
| 96 | 96 | ||
| 97 | + __ `nodegit2` library code is written adhering to a modified `JSHint`. Run these tests with `make lint`. __ | ||
| 98 | + | ||
| 97 | 99 | __ Ensure the submodules `nodeunit` and `rimraf` are located in the `vendor/` subdirectory. __ | |
| 98 | 100 | ||
| 99 | 101 | If they are not, `cd` into the `nodegit2` dir and run the following `git` commands to automatically fetch them: | |
| 100 | 102 | [tim@thinkpad Projects]$ cd nodegit2 | |
| 101 | 103 | [tim@thinkpad nodegit2]$ git submodule init vendor/ | |
| 102 | 104 | [tim@thinkpad nodegit2]$ git submodule update vendor/ | |
| 103 | 105 | ||
| 104 | - Then simply run `make unittest` in the project root. | ||
| 105 | - | ||
| 106 | - Example of building `nodegit2` bindings and running tests: | ||
| 107 | - [tim@thinkpad Projects]$ cd nodegit2 | ||
| 108 | - [tim@thinkpad nodegit2]$ make | ||
| 109 | - [tim@thinkpad nodegit2]$ make unittest | ||
| 110 | - | ||
| 111 | - You will most likely install `nodeunit` and `rimraf` via `npm` or make an alias to the `nodeunit` binary in `vendor/`. | ||
| 112 | - | ||
| 113 | 106 | Release information | |
| 114 | 107 | ------------------- | |
| 115 | 108 | ||
0 commit comments