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

Split Up the Readme #438

Closed
mcrowson opened this issue Oct 27, 2016 · 6 comments
Closed

Split Up the Readme #438

mcrowson opened this issue Oct 27, 2016 · 6 comments

Comments

@mcrowson
Copy link
Collaborator

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.

@Miserlou
Copy link
Owner

Why?

@mcrowson
Copy link
Collaborator Author

Same reason you break any application up as it gets bigger: easier to maintain, consume, and grow.

@collingreen
Copy link
Collaborator

Micro Readmes! The real future of development!

@jnlaia
Copy link
Contributor

jnlaia commented Oct 27, 2016

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.

@mafrosis
Copy link

2 cents: I prefer the single large README

@Miserlou
Copy link
Owner

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

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

5 participants