summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarlos Martín Nieto <[email protected]>2015-03-15 00:45:30 +0100
committerCarlos Martín Nieto <[email protected]>2015-03-15 00:46:15 +0100
commit76d600f7b3633f78e5f1433c16eba4eddfdad3e0 (patch)
tree79237122286e92548fa53b962bb83ed51aee4de8
parentd300110b8582cd44511efc26a7a0ce04d409f8ce (diff)
Correct README on what master tracks
The second mention still said that master tracks master. Add a mention of next which will become the branch to track upstream tip.
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index faeb5f5..51543a8 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@ git2go
[![GoDoc](https://godoc.org/github.com/libgit2/git2go?status.svg)](http://godoc.org/github.com/libgit2/git2go) [![Build Status](https://travis-ci.org/libgit2/git2go.svg?branch=master)](https://travis-ci.org/libgit2/git2go)
-Go bindings for [libgit2](http://libgit2.github.com/). The master branch follows the latest libgit2 release. The versioned branches indicate which libgit2 version they work against.
+Go bindings for [libgit2](http://libgit2.github.com/). The `master` branch follows the latest libgit2 release. The versioned branches indicate which libgit2 version they work against.
Installing
----------
@@ -20,10 +20,11 @@ to use a version of git2go which will work against libgit2 v0.22 and dynamically
### From master
-The master 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.
+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.
Run `go get -d github.com/libgit2/git2go` to download the code and go to your `$GOPATH/src/github.com/libgit2/git2go` dir. From there, we need to build the C code and put it into the resulting go binary.
+ git checkout next
git submodule update --init # get libgit2
make install
@@ -37,7 +38,7 @@ libgit2 uses OpenSSL and LibSSH2 for performing encrypted network connections. F
Running the tests
-----------------
-For the stable version, `go test` will work as usual. For the master branch, similarly to installing, running the tests requires linking against the local libgit2 library, so the Makefile provides a wrapper
+For the stable version, `go test` will work as usual. For the `next` branch, similarly to installing, running the tests requires linking against the local libgit2 library, so the Makefile provides a wrapper
make test