aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Spiers <git@adamspiers.org>2015-01-11 23:38:43 +0000
committerAdam Spiers <git@adamspiers.org>2015-01-11 23:38:43 +0000
commit0161f6f1598e1b270f2d157436038299d8d2715c (patch)
treedd243046fd8c7c740e7d403f583306dab7a6b5dc
parent656c9de2cac32cad7cbadd658f5a630536a471c2 (diff)
downloadgit-deps-0161f6f1598e1b270f2d157436038299d8d2715c.tar.gz
mention pygit2 requirement
This will automatically ensure the user has Python and libgit2 installed :-)
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index caabeab..a093540 100644
--- a/README.md
+++ b/README.md
@@ -70,10 +70,17 @@ single commit.) But this should not stop it from being useful.
Installation
------------
-Just copy or symlink `git-deps` so it's anywhere on your `$PATH`.
+`git-deps` requires [Pygit2](http://www.pygit2.org/), so first
+[install that](http://www.pygit2.org/install.html). If you are using
+Linux, there is a good chance that your distribution already offers
+packages for it. For example, on openSUSE, just do:
-If you want to use the graph visualization web server functionality,
-you will need to install some dependencies:
+ sudo zypper install python-pygit2
+
+Then just copy or symlink `git-deps` so it's anywhere on your `$PATH`.
+
+If you want to use the shiny new graph visualization web server
+functionality, you will need to install some dependencies:
* To install the required Javascript libraries, you will need
[`npm`](https://www.npmjs.com/) installed, and then type: