diff options
| author | Kimmo Brunfeldt <kimmobrunfeldt@gmail.com> | 2015-07-24 13:30:18 +0300 |
|---|---|---|
| committer | Kimmo Brunfeldt <kimmobrunfeldt@gmail.com> | 2015-07-24 13:30:18 +0300 |
| commit | 04db71930e8a2713b73c3c1289a3c80852ced7d8 (patch) | |
| tree | bba291e23e2690ab9223cbbf28fbbdf994688122 | |
| parent | 2c134fd44dd2b10333e1034fb94d7965643bc55b (diff) | |
| download | git-hours-04db71930e8a2713b73c3c1289a3c80852ced7d8.zip git-hours-04db71930e8a2713b73c3c1289a3c80852ced7d8.tar.gz git-hours-04db71930e8a2713b73c3c1289a3c80852ced7d8.tar.bz2 | |
Update installation guide to recommend node 0.12.x
| -rw-r--r-- | .travis.yml | 2 | ||||
| -rw-r--r-- | README.md | 28 |
2 files changed, 19 insertions, 11 deletions
diff --git a/.travis.yml b/.travis.yml index 65131e1..f6f876a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,6 @@ language: node_js node_js: - '0.12' -- '0.11' -- '0.10' sudo: false before_script: - npm install -g mocha grunt-cli nodegit @@ -21,6 +21,25 @@ Estimate time spent on a git repository. From a person working 8 hours per day, it would take more than 3 years to build Bootstrap. +## Install + + $ npm install -g git-hours + +**NOTE: Use node version >=0.12.x.** *You can try to get nodegit working +with older versions too but 0.12.x was the easiest. With older node versions, +you might need to `npm install -g nodegit` too.* + +`git-hours` depends on [nodegit](https://github.com/nodegit/nodegit). +It might be a bit tricky to install. If installing git-hours fails for some +reason, probably it was because nodegit couldn't be installed. +Check [their documentation](https://github.com/nodegit/nodegit#getting-started) for troubleshooting. + +*Nodegit library has been a bit unstable and it might crash randomly. +They have fixed a lot of issues lately though.* + +If the installation is too troublesome, you can try to [install with Vagrant](#install-with-vagrant). It should work out of the box once you get the Vagrant +correctly installed to your machine. + ## How it works The algorithm for estimating hours is quite simple. For each author in the commit history, do the following: @@ -102,15 +121,6 @@ Help For more details, visit https://github.com/kimmobrunfeldt/git-hours -## Install - - $ npm install -g nodegit - $ npm install -g git-hours - -Nodegit library is a bit unstable and might crash randomly. -If you have trouble installing node-git as a dependency, you could -try the vagrant installation. - ## Install with Vagrant If you prefer to use vagrant, here's how: |