Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #70

Open
sraaphorst opened this issue Jun 13, 2018 · 1 comment
Open

Improve documentation #70

sraaphorst opened this issue Jun 13, 2018 · 1 comment
Labels
good first issue Good for newcomers graphmaze Mazes based on Boost.Graph help wanted Extra attention is needed math Mathematical shared parts maze Part of the standard Maze library thickmaze Part of the ThickMaze sub-library type classes Type class library

Comments

@sraaphorst
Copy link
Owner

This is an umbrella task for PRs that are related to adding documentation to the library.
@sraaphorst sraaphorst added help wanted Extra attention is needed good first issue Good for newcomers thickmaze Part of the ThickMaze sub-library maze Part of the standard Maze library type classes Type class library math Mathematical shared parts graphmaze Mazes based on Boost.Graph labels Jun 13, 2018
@sraaphorst
Copy link
Owner Author

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.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers graphmaze Mazes based on Boost.Graph help wanted Extra attention is needed math Mathematical shared parts maze Part of the standard Maze library thickmaze Part of the ThickMaze sub-library type classes Type class library
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sraaphorst