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

Move most documentation out of README.md #35

Open
eyalroz opened this issue Sep 14, 2019 · 1 comment
Open

Move most documentation out of README.md #35

eyalroz opened this issue Sep 14, 2019 · 1 comment

Comments

@eyalroz
Copy link

eyalroz commented Sep 14, 2019

This repository's README.md is way too long. The documentation specifics should be in a separate .md file, on the wiki, or both; and the main README.md should focus on the sections other than the Detailed Examples. In fact, Overview is also too long; I'd stick to a couple of examples, no more than that for the repo landing page.

@muellan
Copy link
Owner

muellan commented Sep 18, 2019

Agreed. That's already on my TODO-list.

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

No branches or pull requests

2 participants