From c7ac950815223aa8a2457571d4013387f3b50454 Mon Sep 17 00:00:00 2001 From: Carlos Martín Nieto Date: Thu, 3 Jul 2014 08:47:38 +0200 Subject: Update README Specify that we stick to the release and how to run the tests. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index cc42e9c..84ac116 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ git2go ====== -Go bindings for [libgit2](http://libgit2.github.com/). These bindings are for top-of-the-branch libgit2, and they move fast, things may or may not work. Operator get me Beijing-jing-jing-jing! +Go bindings for [libgit2](http://libgit2.github.com/). The master branch follows the latest libgit2 release. Installing ---------- @@ -15,6 +15,19 @@ Run `go get github.com/libgit2/git2go` to download the code and go to your `$GOP will compile libgit2 and run `go install` such that it's statically linked to the git2go package. +Running the tests +----------------- + +Similarly to installing, running the tests requires linking against the local libgit2 library, so the Makefile provides a wrapper + + make test + +alternatively, if you want to pass arguments to `go test`, you can use the script that sets it all up + + ./script/with-static.sh go test -v + +which will run the specified arguments with the correct environment variables. + License ------- -- cgit v1.2.3