git2go/README.md

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.

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 if you want to use HTTPS and SSH respectively.

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 submodule update --init # get libgit2
    make install

will compile libgit2 and run `go install` such that it's statically linked to the git2go package.

Paralellism and network operations
----------------------------------

libgit2 uses OpenSSL and LibSSH2 for performing encrypted network connections. For now, git2go asks libgit2 to set locking for OpenSSL. This makes HTTPS connections thread-safe, but it is fragile and will likely stop doing it soon. This may also make SSH connections thread-safe if your copy of libssh2 is linked against OpenSSL. Check libgit2's `THREADSAFE.md` for more information.

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
-------

M to the I to the T. See the LICENSE file if you've never seen a MIT license before.

Authors
-------

- Carlos Martín (@carlosmn)
- Vicent Martí (@vmg)
Initial commit 2013-03-05 13:53:04 -06:00			`git2go`
			`======`
Add build status to README 2014-12-04 13:51:41 -06:00			`[![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)`
Updates README.md to include GoDoc badge. 2014-10-28 12:40:35 -05:00
Initial commit 2013-03-05 13:53:04 -06:00
Update README Specify that we stick to the release and how to run the tests. 2014-07-03 01:47:38 -05:00			`Go bindings for [libgit2](http://libgit2.github.com/). The master branch follows the latest libgit2 release.`
Update README 2013-03-06 10:06:01 -06:00
			`Installing`
			`----------`

Upate README with static instructions 2014-06-07 12:21:38 -05:00			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 if you want to use HTTPS and SSH respectively.
Use a submodule for libgit2 This makes building the static version easier as we know where the repo is and that it's has a known-good version. 2014-06-06 19:58:28 -05:00
README: add -d flag to 'go get' To make sure it doesn't try to build it. 2014-10-31 17:20:57 -05:00			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.
Use a submodule for libgit2 This makes building the static version easier as we know where the repo is and that it's has a known-good version. 2014-06-06 19:58:28 -05:00
Upate README with static instructions 2014-06-07 12:21:38 -05:00			`git submodule update --init # get libgit2`
			`make install`

			will compile libgit2 and run `go install` such that it's statically linked to the git2go package.
Initial commit 2013-03-05 13:53:04 -06:00
Update to master 2014-12-02 18:50:37 -06:00			`Paralellism and network operations`
			`----------------------------------`

			libgit2 uses OpenSSL and LibSSH2 for performing encrypted network connections. For now, git2go asks libgit2 to set locking for OpenSSL. This makes HTTPS connections thread-safe, but it is fragile and will likely stop doing it soon. This may also make SSH connections thread-safe if your copy of libssh2 is linked against OpenSSL. Check libgit2's `THREADSAFE.md` for more information.

Update README Specify that we stick to the release and how to run the tests. 2014-07-03 01:47:38 -05:00			`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.`

Initial commit 2013-03-05 13:53:04 -06:00			`License`
			`-------`

Update README 2013-03-06 10:06:01 -06:00			`M to the I to the T. See the LICENSE file if you've never seen a MIT license before.`
Initial commit 2013-03-05 13:53:04 -06:00
			`Authors`
			`-------`

My username is carlosmn 2013-03-05 14:00:31 -06:00			`- Carlos Martín (@carlosmn)`
Initial commit 2013-03-05 13:53:04 -06:00			`- Vicent Martí (@vmg)`