frost/secp256k1-zkp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: mention optional modules in README

Browse Source
This commit is contained in:
Elliott Jin 2022-03-25 07:09:36 -07:00
parent d0ad5814a5
commit d9d94a9969
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -68,12 +68,15 @@ libsecp256k1 is built using autotools:
$ make check # run the test suite $ make check # run the test suite
$ sudo make install # optional $ 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
----------- -----------
Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-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) * [ECDSA example](examples/ecdsa.c)
* [Schnorr Signatures example](examples/schnorr.c) * [Schnorr signatures example](examples/schnorr.c)
* [Deriving a shared secret(ECDH) example](examples/ecdh.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 Test coverage
----------- -----------