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 #5

Closed
rubensworks opened this issue Dec 2, 2019 · 2 comments
Closed

Add documentation #5

rubensworks opened this issue Dec 2, 2019 · 2 comments

Comments

@rubensworks
Copy link

rubensworks commented Dec 2, 2019 •
edited
Loading

Adding basic usage information about this tool would drastically improve its usability, as people don't really know how to use this without diving into the source code.
I've created a template that can be used as a start for documentation within the README.
@JJ
Copy link

JJ commented Apr 5, 2022

Increasingly necessary, now that the API has changed...

@bergos
Copy link
Contributor

bergos commented Apr 10, 2022

fixed in #13

@bergos bergos closed this as completed Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JJ @rubensworks @bergos