realworldocaml / mdx

Execute code blocks inside your documentation
ISC License
269 stars 45 forks source link

Revamp README #442

Open sorawee opened 11 months ago

sorawee commented 11 months ago

This is a draft of a README improvement. Right now I only made a pass on the first few sections, but I intend to go through all of them. Eventually, we can also port the README to odoc (as attempted in the stale #355). I submit this a a draft PR now in case anyone would like to provide a feedback.

Intending to resolve: #421, #352, and #273

Help needed

If anyone knows the compatibility of MDX stanza 0.3 (what version of MDX and Dune it works with), please let me know!