summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Beer <[email protected]>2015-07-29 11:28:05 +0200
committerAndreas Beer <[email protected]>2015-07-29 11:28:05 +0200
commit47d82916e2f9720470a44db22ed942ffcca20a20 (patch)
tree74c4ad39d09662c61b7fa8df148b8d0b7688bc4d
parentf2d8797a96903048016221e7756a6ab490492d6b (diff)
Typos/unclarities in readme.
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 386ff83..49e1ae9 100644
--- a/README.md
+++ b/README.md
@@ -8,13 +8,13 @@ Go bindings for [libgit2](http://libgit2.github.com/). The `master` branch follo
Installing
----------
-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.
+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 manaager 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 `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
+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 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"
@@ -28,13 +28,13 @@ to use the version which works against the latest release.
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.
+Run `go get -d github.com/libgit2/git2go` to download the code and go to your `$GOPATH/src/github.com/libgit2/git2go` directory. 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
-will compile libgit2 and run `go install` such that it's statically linked to the git2go package.
+will compile libgit2. Run `go install` so that it's statically linked to the git2go package.
Paralellism and network operations
----------------------------------
@@ -48,7 +48,7 @@ For the stable version, `go test` will work as usual. For the `next` branch, sim
make test
-alternatively, if you want to pass arguments to `go test`, you can use the script that sets it all up
+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