From d9d94a9969785abbb3e04b2b9f75f1049c7b8936 Mon Sep 17 00:00:00 2001 From: Elliott Jin Date: Fri, 25 Mar 2022 07:09:36 -0700 Subject: [PATCH] doc: mention optional modules in README --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e347889c84383..f5db915e83e7b 100644 --- a/README.md +++ b/README.md @@ -68,12 +68,15 @@ libsecp256k1 is built using autotools: $ make check # run the test suite $ sudo make install # optional +To compile optional modules (such as Schnorr signatures), you need to run `./configure` with additional flags (such as `--enable-module-schnorrsig`). Run `./configure --help` to see the full list of available flags. + Usage examples ----------- Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`. * [ECDSA example](examples/ecdsa.c) - * [Schnorr Signatures example](examples/schnorr.c) - * [Deriving a shared secret(ECDH) example](examples/ecdh.c) + * [Schnorr signatures example](examples/schnorr.c) + * [Deriving a shared secret (ECDH) example](examples/ecdh.c) + To compile the Schnorr signature and ECDH examples, you also need to configure with `--enable-module-schnorrsig` and `--enable-module-ecdh`. Test coverage -----------