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.

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

Documentation #6

Open
1 of 2 tasks
ma3ke opened this issue Mar 8, 2024 · 0 comments
Open
1 of 2 tasks

Documentation #6

ma3ke opened this issue Mar 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ma3ke
Copy link
Collaborator

ma3ke commented Mar 8, 2024

This is a tracking issue for matters of documentation in this project.

We have reached a state where some parts are becoming solid enough to document without fear of immediate upheaval.
Most importantly, the outward-facing usage of the program must be documented clearly and with sufficient examples.
One such effort is described in #3 as well.

As a concrete task that warrants most attention right now, is the README.

@ma3ke ma3ke added the documentation Improvements or additions to documentation label Mar 8, 2024
ma3ke added a commit that referenced this issue Mar 12, 2024
Covers the Installation, Basic usage, and a bit of the Summary sections
in issue #6.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant