From: Matt Corallo Date: Fri, 11 Sep 2020 18:45:45 +0000 (-0400) Subject: Add developer guideline notes for C/C++ bindings generation X-Git-Tag: v0.0.12~29^2~4 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=83322e1c0dbf83b16d7f38de0bcf8e9b82063480;p=rust-lightning Add developer guideline notes for C/C++ bindings generation --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b6e07acf..b270492bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,6 +99,17 @@ Fuzzing is heavily encouraged: you will find all related material under `fuzz/` Mutation testing is work-in-progress; any contribution there would be warmly welcomed. +C/C++ Bindings +-------------- + +You can learn more about the C/C++ bindings that are made available by reading the +[C/C++ Bindings README](lightning-c-bindings/README.md). If you are not using the C/C++ bindings, +you likely don't need to worry about them, and during their early experimental phase we are not +requiring that pull requests keep the bindings up to date (and, thus, pass the bindings_check CI +run). If you wish to ensure your PR passes the bindings generation phase, you should run the +`genbindings.sh` script in the top of the directory tree to generate, build, and test C bindings on +your local system. + Going further -------------