Permalink
Browse files

Merge pull request #66 from cubehero/master

updated README to include build instructions
  • Loading branch information...
samcday committed Aug 25, 2013
2 parents 5b26203 + 845ee56 commit 11ece48fc3cf38788ec07c166fe03874cddce025
Showing with 21 additions and 2 deletions.
  1. +21 −2 README.md
View
@@ -22,12 +22,31 @@ Gitteh aims to:
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.
-[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.
+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.
## License
Gitteh is available under the MIT License. See the LICENSE file for more information.
## Contributing
-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!
+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!
+
+### Building
+
+In order to build Gitteh, you first need to install coffee-script.
+[Coffee-script](http://coffeescript.org/) is not needed to use the library, only to
+work with the source.
+
+ npm install -g coffee-script
+
+Next, you need to install gitteh's dependencies. In gitteh's root directory, run:
+
+ npm install
+
+Lastly, you need to compile and build gitteh
+
+ cake build
+
+It should generate `lib/gitteh.js` for you to use. Happy hacking!
+

0 comments on commit 11ece48

Please sign in to comment.