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

Add documentation #7

Open
MobiusM opened this issue Nov 1, 2020 · 0 comments
Open

Add documentation #7

MobiusM opened this issue Nov 1, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@MobiusM
Copy link
Owner

MobiusM commented Nov 1, 2020 •
edited

Although the code is documented well, add external documentation in a form of a wiki. It should mainly include usage examples.
In addition, add an informative README.md file.
@MobiusM MobiusM added the documentation Improvements or additions to documentation label Nov 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MobiusM