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

adding Documentation #7

Open
noah1510 opened this issue Mar 11, 2021 · 0 comments
Open

adding Documentation #7

noah1510 opened this issue Mar 11, 2021 · 0 comments

Comments

@noah1510
Copy link

I am interested in using the library but could not find much documentation. The example is not very helpful either if you don't even know how the library works.
It would be nice to have some more examples (that also have descriptions) and to have an API documentation (maybe generated by doxygen or some similar software).
These should also be linked in the readme so that new developers can get started without many problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant