fluxcd
/
image-automation-controller
mirror of https://github.com/fluxcd/image-automation-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document libgit2 requirement in README 

Signed-off-by: Michael Bridgen <michael@weave.works>
This commit is contained in:
Michael Bridgen 2021-01-12 18:00:20 +00:00 committed by Hidde Beydals
parent 42241f2dd1
commit c5322814d9
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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`.