diff --git a/README.md b/README.md index fe0c595..aaf03df 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,31 @@ ## Build -How to build with libgit2 statically linked into a single executable without dependencies: +How to build with `libgit2` statically linked into a single executable without dependencies: - Install development packages for libssh2 and openssl: ``` - sudo apt install libssh2-1-del libssl-dev + sudo apt install libssh2-1-dev libssl-dev ``` -- `git2go` library is added as a submodule (pointing to a correct v30 release). This, in turn, contains `libgit2` submodule. - To ensure the submodules are cloned run: +- Inside the `static` folder there's the `git2go` library added as a submodule (pointing to a correct v30 release). + This, in turn, contains `libgit2` submodule. To ensure the submodules are cloned run: ``` git submodule update --init --recursive ``` -- build the static `git2go` library: +- Build the static `git2go` library: ``` cd static/git2go && make install-static ``` -- ensure our `git-get` module uses the static `git2go` library instead of the one downloaded by Go modules by having +- Ensure our `git-get` module uses the static `git2go` library instead of the one downloaded by Go modules by having the following line in `go.mod`: ``` replace github.com/libgit2/git2go/v30 => ./static/git2go ``` -- build `git-get` with `--tags static` flag: +- Build `git-get` with `--tags static` flag: ``` go build -i --tags static ```