-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Split Up the Readme #438
Comments
Why? |
Same reason you break any application up as it gets bigger: easier to maintain, consume, and grow. |
Micro Readmes! The real future of development! |
I think there is one important advantage of having one big readme file: one can search for a string in the entire document and go to the relevant section easily. |
2 cents: I prefer the single large README |
Yep, me too. "Just because" isn't a good enough reason for me. Closing to prevent any further bikeshedding. This, however, still needs to be resolved: #243 |
As zappa's documentation has gotten really big, the readme has grown with it. I suggest having a high level overview with links in the readme, and a link to the complete documentation a-la readthedocs or something similar.
The text was updated successfully, but these errors were encountered: