README: add link to musig example #1683

pull theStack wants to merge 1 commits into bitcoin-core:master from theStack:readme-mention_musig_example changing 1 files +2 −1

theStack commented at 2:18 PM on June 7, 2025: contributor

No description provided.

in README.md:156 in c10f50c9de outdated

 150 | @@ -151,6 +151,7 @@ Usage examples can be found in the [examples](examples) directory. To compile th
 151 |    * [Schnorr signatures example](examples/schnorr.c)
 152 |    * [Deriving a shared secret (ECDH) example](examples/ecdh.c)
 153 |    * [ElligatorSwift key exchange example](examples/ellswift.c)
 154 | +  * [MuSig2 Schnorr multi-signatures example](examples/musig.c)
 155 |  
 156 |  To compile the Schnorr signature and ECDH examples, you also need to configure with `--enable-module-schnorrsig` and `--enable-module-ecdh`.

jonasnick commented at 2:40 PM on June 9, 2025:

While we're at it, could you also fix the inconsistent sentence "To compile the ..."? Even before this PR it should also mention the ellswift module and --enable-module-ellswift. Maybe we can replace the sentence with something like this:

To compile the examples, make sure the corresponding modules are enabled.

theStack commented at 2:56 PM on June 16, 2025:

Makes sense, done.

real-or-random added the label user-documentation on Jun 10, 2025
real-or-random added the label refactor/smell on Jun 10, 2025
README: add link to musig example, generalize module enabling hint
Co-authored-by: Jonas Nick <jonasd.nick@gmail.com>
819210974b
theStack force-pushed on Jun 16, 2025
real-or-random approved
real-or-random commented at 3:08 PM on June 16, 2025: contributor

ACK 819210974bd91bbbe6cc2e691b12c3e6130aa9d5
real-or-random merged this on Jun 24, 2025
real-or-random closed this on Jun 24, 2025
theStack deleted the branch on Jun 24, 2025

Contributors

theStack

jonasnick

real-or-random

Labels

user-documentation refactor/smell