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

Proper documentation #83

Open
greimel opened this issue Nov 3, 2020 · 1 comment
Open

Proper documentation #83

greimel opened this issue Nov 3, 2020 · 1 comment

Comments

@greimel
Copy link
Collaborator

greimel commented Nov 3, 2020

As the set of features increase the README is getting longer and longer.

Wouldn't it be time to set up proper multi-page documentation at some point? Or is there a reason to keep it as it is?

@jmboehm
Copy link
Owner

jmboehm commented Nov 3, 2020

I don't have strong views on this. I quite like docs on the repo page, and I think the current readme is still manageable. But feel free to set up proper docs if you think it would be good to have.

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

2 participants