Documentation should provide example callers. #184

1. 
   gmaxwell commented at 4:52 am on January 11, 2015: contributor

   We’ve seen some people attempting to use the library calling into random internal functions. That should be harder to do now… but now that the basic signature interface is relatively safe to use (as such things go) there should be some easy copy and paste examples for correct usage.
2. gmaxwell added the label documentation on Jan 11, 2015
3. gmaxwell assigned gmaxwell on Jan 11, 2015
4. gmaxwell added this to the milestone initial release on Aug 27, 2015
5. gmaxwell cross-referenced this on Feb 20, 2019 from issue Simple usage example by josephernest
6. 
   jonasnick commented at 3:19 pm on February 21, 2019: contributor

   As an example we have someting like this in secp256k1-zkp to demonstrate musig: https://github.com/ElementsProject/secp256k1-zkp/blob/secp256k1-zkp/src/modules/musig/example.c
7. gmaxwell cross-referenced this on May 23, 2019 from issue Add better build documentation by gmaxwell
8. real-or-random cross-referenced this on Oct 11, 2019 from issue Storing and loading the private key by kroggen
9. 
   nickfarrow commented at 11:46 pm on March 24, 2020: none

   For anyone else interested in how to generate keys using this library, feel free to checkout my Bitcoin vanity address generator which I think provides a short and reasonably well commented example of how to generate private and public key pairs.
10. jonasnick cross-referenced this on Apr 28, 2020 from issue Add Usage section to README.md by jonasnick
11. jonasnick renamed this:
    Docucmentation should provide example callers.
    Documentation should provide example callers.
    on Apr 28, 2020
12. 
    jonasnick commented at 8:33 am on April 28, 2020: contributor

    I’d suggest to add a short and well documented example source file for every module and build and run it as part of make check. We can list the modules in the README and from there link to the examples and include files for more documentation.
13. elichai cross-referenced this on Apr 30, 2020 from issue Add usage examples by elichai
14. jonasnick closed this on Feb 23, 2022

    ---

Contributors
gmaxwell jonasnick nickfarrow

Labels
documentation

Milestone
stable release (1.0.0-rc.1)