summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCarlos Martín Nieto <[email protected]>2015-03-15 01:21:21 +0100
committerCarlos Martín Nieto <[email protected]>2015-03-15 01:21:21 +0100
commit1b44c0a2343cc87cb32513ef4625c590c8ecbe8e (patch)
tree019fcb94320b7ad6c3d5f8f0063d38c91eb448d0 /README.md
parent76d600f7b3633f78e5f1433c16eba4eddfdad3e0 (diff)
Add a bit more on next vs master
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 51543a8..386ff83 100644
--- a/README.md
+++ b/README.md
@@ -8,17 +8,23 @@ Go bindings for [libgit2](http://libgit2.github.com/). The `master` branch follo
Installing
----------
-This project needs libgit2, which is written in C so we need to build that as well. In order to build libgit2, you need `cmake`, `pkg-config` and a C compiler. You will also need the development packages for OpenSSL and LibSSH2 installed if you want libgit2 to support HTTPS and SSH respectively.
+This project wraps the functionality provided by libgit2. If you're using a stable version, install it to your system via your system's package manger and then install git2go as usual.
+
+Otherwise (`next` which tracks an unstable version), we need to build libgit2 as well. In order to build it, you need `cmake`, `pkg-config` and a C compiler. You will also need the development packages for OpenSSL and LibSSH2 installed if you want libgit2 to support HTTPS and SSH respectively.
### Stable version
-git2go has versioned branches which indicate which version of libgit2 they work against. Install the development package it on your system via your favourite package manager or from source and you can use a service like gopkg.in to use the appropriate version. For the libgit2 v0.22 case, you can use
+git2go has `master` which tracks the latest release of libgit2, and versioned branches which indicate which version of libgit2 they work against. Install the development package it on your system via your favourite package manager or from source and you can use a service like gopkg.in to use the appropriate version. For the libgit2 v0.22 case, you can use
import "gopkg.in/libgit2/git2go.v22"
-to use a version of git2go which will work against libgit2 v0.22 and dynamically link to the library.
+to use a version of git2go which will work against libgit2 v0.22 and dynamically link to the library. You can use
+
+ import "github.com/libgit2/git2go"
+
+to use the version which works against the latest release.
-### From master
+### From `next`
The `next` branch follows libgit2's master branch, which means there is no stable API or ABI to link against. git2go can statically link against a vendored version of libgit2.