Skip to content

Commit 11ece48

Browse files
author
Sam
committed
Merge pull request #66 from cubehero/master
updated README to include build instructions
2 parents 5b26203 + 845ee56 commit 11ece48

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,31 @@ Gitteh aims to:
2222

2323
There's a few libraries out there that wrap git cli commands, parsing the output and such. This is a perfectly acceptable solution. Node-gitteh provides first-class support to work with a git repository on a low level, and does not require git.git (and its myriad of dependencies) to be installed in the server environment.
2424

25-
[Documentation can be found here](http://libgit2.github.com/node-gitteh/docs/index.html). You should also check out the examples in the examples/ dir in the repo.
25+
The documentation is currently outdated. We're working on a new version currently for the new 0.17.x version of gitteh. The [Old pre-0.17.x documentation can be found here](http://libgit2.github.com/node-gitteh/docs/index.html). Instead, you should visit [`examples`](https://github.com/libgit2/node-gitteh/tree/master/examples) dir in the repo to see examples of 0.17.x usage.
2626

2727
## License
2828

2929
Gitteh is available under the MIT License. See the LICENSE file for more information.
3030

3131
## Contributing
3232

33-
Contributions are very welcome. Please feel free to fork this project and hack on it. Go ahead and check out the issues tab to see what needs to be done! Go on! Do it!
33+
Contributions are very welcome. Please feel free to fork this project and hack on it. Go ahead and check out the issues tab to see what needs to be done! Go on! Do it!
34+
35+
### Building
36+
37+
In order to build Gitteh, you first need to install coffee-script.
38+
[Coffee-script](http://coffeescript.org/) is not needed to use the library, only to
39+
work with the source.
40+
41+
npm install -g coffee-script
42+
43+
Next, you need to install gitteh's dependencies. In gitteh's root directory, run:
44+
45+
npm install
46+
47+
Lastly, you need to compile and build gitteh
48+
49+
cake build
50+
51+
It should generate `lib/gitteh.js` for you to use. Happy hacking!
52+

0 commit comments

Comments
 (0)