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

Readme rework #54

Merged
merged 15 commits into from
Feb 18, 2019
Merged

Readme rework #54

merged 15 commits into from
Feb 18, 2019

Conversation

roipoussiere
Copy link

As suggested in a comment on the PR #53, make changes on readme in the dev branch.

This includes:

  • move fork explanation to the end of readme (better readability);
  • add license section;
  • move badges to the top (quick access);
  • improve titles structure;
  • add summary;
  • fix typos and other minor improvements;
  • add contribution guide with some love inside.

To a better understanding, all of these steps are done in separated commits but fill free to squash them.

Copy link
Owner

@Ionaru Ionaru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of small things I've noticed, other than that it looks good!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@roipoussiere
Copy link
Author

roipoussiere commented Feb 13, 2019

Thanks for the suggestion! I didn't know that we can do this kind of list with GFM, by local markdown editor don't render them like that.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@Ionaru Ionaru merged commit cae4543 into Ionaru:development Feb 18, 2019
@roipoussiere roipoussiere deleted the readme_rework_dev branch February 18, 2019 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants