HugoGranstrom / nimiSlides

A Reveal.js theme for nimib for making slideshow presentations in Nim
https://hugogranstrom.com/nimiSlides
MIT License
80 stars 6 forks source link

Improve documentation #14

Open HugoGranstrom opened 1 year ago

HugoGranstrom commented 1 year ago

Currently the documentation consists of the README and the example slides in docs/. This could be improved, both by having a compiler-generated API docs and more specific example slides in the style of NimConf, where a piece of code is shown next to what it renders. Ideas for what these small tutorials should cover are welcomed.

This was brought up by @srozb .

Ideas thus far:

HugoGranstrom commented 1 year ago

Write about gotchas: