jupyter / jupyter_markdown

Documentation and tests related to Jupyter's Markdown syntax
BSD 3-Clause "New" or "Revised" License
8 stars 10 forks source link

Improve README; Depth & Breadth #9

Open mpacer opened 6 years ago

mpacer commented 6 years ago

The readme should cover in greater detail what this repo is for.

The readme should also have a guide for how to run the tests and what to expect as a result of the output.

We should come up with a roadmap for all that we want to do in this repo, possibly include it in the README with GFM checkboxes.