search

sraaphorst / spelunker

Maze generation and solving library
Other
11 stars 2 forks source link

Improve documentation #70

Open sraaphorst opened 6 years ago

sraaphorst commented 6 years ago

This is an umbrella task for PRs that are related to adding documentation to the library.

sraaphorst commented 6 years ago

We need to flesh out each section with a README.md section.

typeclasses is a good candidate, as it is fairly easy.

maze is essential, so I can document the algorithms and, from there, determine what signals we need to be able to emit to the UI. (Similarly for ThickMaze. GraphMaze is still proof-of-concept and should wait.)