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

Simplify root README.md #7766

Merged
merged 11 commits into from Apr 8, 2016
Merged

Simplify root README.md #7766

merged 11 commits into from Apr 8, 2016

Conversation

@islemaster
Copy link
Member

islemaster commented Apr 8, 2016

I promised to do a pass on our root README a long time ago. Finally, here it is.

The diff on this is terrible, so here's a side-by-side view. Left is before, right is after.

readme_diff_1024

Note, I moved the apps-build sets to SETUP.md.

@islemaster islemaster changed the title [WIP] Simplifying root README.md Simplify root README.md Apr 8, 2016
@islemaster

This comment has been minimized.

Copy link
Member Author

islemaster commented Apr 8, 2016

Please discuss in depth. I think this is a major improvement because:

  • It moves setup/build/run instructions to the top.
  • It's a little bit shorter
  • It manages to express a lot more information about our repository structure
  • It tears out quite a bit of outdated or redundant information about building and running our app (which should be in SETUP.md anyway)
@philbogle

This comment has been minimized.

Copy link
Contributor

philbogle commented Apr 8, 2016

This looks really good to me; I think it's strictly an improvement.

@ashercodeorg

This comment has been minimized.

Copy link
Contributor

ashercodeorg commented Apr 8, 2016

Thanks for doing this! And thanks for including the visual diff!

@bcjordan

This comment has been minimized.

Copy link
Contributor

bcjordan commented Apr 8, 2016

Looks great, much improved experience for newcomers 👍 👍 — thanks for doing this!

@islemaster islemaster merged commit d7be329 into staging Apr 8, 2016
5 checks passed
5 checks passed
ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.08%) to 84.495%
Details
hound No violations found. Woof!
@islemaster islemaster deleted the simplify-readme branch Apr 8, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.