From c5322814d9040fc896dd5636d90891a150f4eda5 Mon Sep 17 00:00:00 2001 From: Michael Bridgen Date: Tue, 12 Jan 2021 18:00:20 +0000 Subject: [PATCH] Document libgit2 requirement in README Signed-off-by: Michael Bridgen --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index d47b468..fbe8355 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,14 @@ updating YAML files in a git repository, and committing the changes. Please see the [installation and use guide](https://toolkit.fluxcd.io/guides/image-update/). + +## How to work on it + +The shared library `libgit2` needs to be installed to test or build +locally. The version required corresponds to the version of git2go +(which are Go bindings for libgit2), according to [this +table](https://github.com/libgit2/git2go#which-go-version-to-use). + +See +https://github.com/fluxcd/source-controller/blob/main/CONTRIBUTING.md#installing-required-dependencies +for instructions on how to install `libgit2`.