Convert book into "literate radare"

[XVilka]

There is a concept of literate programming, and running the code from the documentation. We should make a scripts/change the book to do exactly the same. So what we need:

• [ ] Change the code examples into being reproducible and self contained
• [ ] Allow to run the code examples on some external binary files
• [ ] Script to "build"/"run" the book like we do for the testcase.
• [ ] Ideally provide a way to run also r2pipe scripts the same way.

[XVilka]

Like rustdoc does: https://doc.rust-lang.org/beta/rustdoc/documentation-tests.html

[radare]

👍

On 15 Nov 2017, at 02:04, Anton Kochkov [email protected] wrote:

Like rustdoc does: https://doc.rust-lang.org/beta/rustdoc/documentation-tests.html

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

[XVilka]

After it is done - we may be even can add the checks into the radare2 PR/master to check every commit automatically.

[XVilka]

Or this https://github.com/realworldocaml/mdx

[XVilka]

Started a PoC here: https://gist.github.com/XVilka/12faa18643e66a184699aa717d8f6f2e

[Maijin]

👍 I made a POC too of this looooong time ago