bitcoinconsensus library needs documentation+examples #5311

As mentioned in #5235. Learning to use a library is easier when there is basic documentation and some simple examples.

Creating an issue for this so that it will not get lost.

I have a bitcoinj branch that has a relatively simple one or two commits that might be good things to point to...I'll dig that up after 0.10 freeze/rc1 (someone should remind me)

On 11/19/14 11:13, Wladimir J. van der Laan wrote:

As mentioned in #5235 #5235. Learning to use a library is easier when there is basic documentation and some simple examples.

Creating an issue for this so that it will not get lost.

— Reply to this email directly or view it on GitHub #5311.

Agreed. It'd be great to have some docs and sample snippets up on github via pages. Also, a good candidate for thorough doxyfication. @fanquake since you've been poking there lately, did you have plans in mind for hooking up the doxygen output somewhere? It'd be great to find some doxygen->markdown bridge.

For reference, here's one I randomly stumbled on a few days go: https://libgit2.github.com/docs/guides/101-samples/ https://libgit2.github.com/libgit2/#HEAD

Obviously that's overkill for us now, but assuming the lib trend keeps rolling, it'd be nice to think ahead some.

@theuni I have automatic doxygen output for the whole project here: https://dev.visucore.com/bitcoin/doxygen/ . For an "API reference", we'd of course want to restrict it to only the interface, but just in case you didn't know.

@laanwj I didn't know that, thanks.

Noting here so I don't forget: We need a pkg-config file before release as well.

@TheBlueMatt You said to remind you about your bitcoinj example :)

Have you done work on Java/JVM bindings? I'm interested in learning about libconsensus and writing tests for it as part of the bitcoin-spock project. I created https://github.com/msgilligan/bitcoin-spock/issues/55 to track progress and request help.

Looks to be closed by #6430.