Skip to content

Commit

Permalink
Updated readme and build process
Browse files Browse the repository at this point in the history
  • Loading branch information
tbranyen committed Feb 21, 2011
1 parent 018849b commit 4633eb3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
2 changes: 2 additions & 0 deletions Makefile
Expand Up @@ -10,6 +10,8 @@ all:
unittest:
$(NODEJS) $(BASE)/test/index.js test

configure:

install:
node-waf install

Expand Down
19 changes: 11 additions & 8 deletions README.md
Expand Up @@ -5,13 +5,19 @@ Created by Tim Branyen [@tbranyen](http://twitter.com/tbranyen)

Currently under active development, `nodegit2` will provide asynchronous native bindings to the `libgit2` C API.

Building
--------
Building and installing
-----------------------

### Dependancies ###
To use `nodegit2`, you will need to have the `libgit2` shared library in `/usr/local/lib` and the `NodeJS`
framework installed, you will also need `git` installed and accessible from your `PATH` to fetch any `vendor/` addons.

### Using `NPM` ###

The easiest way to get `nodegit2` \*Note: If you do not have write privileges to `/usr/local/lib` this will need to be run as superuser:

[tim@thinkpad Projects]$ npm install nodegit2

### Linux/Mac OS X/BSD Variants ###
__ You can skip this step and `nodegit2` will automatically fetch and install a fresh copy of `libgit2` for you. __

Expand All @@ -31,11 +37,12 @@ __ You can skip this step and `nodegit2` will automatically fetch and install a
[tim@thinkpad node-v0.4.0]$ make
[tim@thinkpad node-v0.4.0]$ sudo make install

#### Install `nodegit2` by cloning source from __GitHub__ and running the `make` and `make install` commands. (Future will be on NPM) ####
#### Install `nodegit2` by cloning source from __GitHub__ and running the `make` and `make install` commands. ####
\* Remember you only need to run make as superuser if you want `nodegit2` to install `libgit2` for you. \*

[tim@thinkpad Projects]$ git clone git@github.com:tbranyen/nodegit2.git
[tim@thinkpad Projects]$ cd nodegit2
[tim@thinkpad nodegit2]$ make
[tim@thinkpad nodegit2]$ sudo make
[tim@thinkpad nodegit2]$ make install

### Windows via Cygiwn ###
Expand All @@ -45,10 +52,6 @@ __ You can skip this step and `nodegit2` will automatically fetch and install a
Instructions on compiling `NodeJS` on a Windows platform can be found here:
[https://github.com/ry/node/wiki/Building-node.js-on-Cygwin-(Windows)](https://github.com/ry/node/wiki/Building-node.js-on-Cygwin-(Windows\))

### \*Important linking information\* ###

__ To use these bindings you will need to create a symbolic link (unless you installed via NPM) into `/usr/local/lib/node/` or wherever `NodeJS` is installed to the `nodegit2` path. __

API Example Usage
-----------------

Expand Down

0 comments on commit 4633eb3

Please sign in to comment.