From 10c058dcb9983de24a2ee96c22c56b108dc9b664 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= Date: Sat, 7 Jun 2014 19:21:38 +0200 Subject: [PATCH] Upate README with static instructions --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9a48709..cc42e9c 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,14 @@ Go bindings for [libgit2](http://libgit2.github.com/). These bindings are for to Installing ---------- -This project needs libgit2, which is written in C so we need to take an extra step. Run `go get github.com/libgit2/git2go` and go to your `$GOROOT/src/github.com/libgt2/git2go` dir. From there, we need to build the C code and put it into the resulting go binary. +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. - git submodule update --init - make install +Run `go get github.com/libgit2/git2go` to download the code and go to your `$GOPATH/src/github.com/libgt2/git2go` dir. From there, we need to build the C code and put it into the resulting go binary. -will compile libgit2, build it statically into git2go and install the resulting object file where your Go project can use it. + 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. License -------