Skip to content

improve readme readability #40

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Mar 18, 2020
Merged

improve readme readability #40

merged 4 commits into from
Mar 18, 2020

Conversation

tomerd
Copy link
Contributor

@tomerd tomerd commented Mar 13, 2020

motivation: clearer readme

changes:

  • fix alignment of bullet points
  • add some spaces to break up sentences

@tomerd tomerd requested review from fabianfett and glbrntt March 13, 2020 22:00
fabianfett
fabianfett reviewed Mar 15, 2020
View reviewed changes
Copy link
Member

@fabianfett fabianfett left a comment •
edited
Loading

Choose a reason for hiding this comment

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

At multiple places text that should be indented for readability is not indented anymore (in the rendered output by GitHub). See yourself by changing branches on this site.

fabianfett
fabianfett requested changes Mar 15, 2020
View reviewed changes
Copy link
Member

@fabianfett fabianfett left a comment

Choose a reason for hiding this comment

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

At multiple places text that should be indented for readability is not indented anymore (in the rendered output by GitHub). See yourself by changing branches on this site.

glbrntt
glbrntt suggested changes Mar 18, 2020
View reviewed changes
tomerd added 2 commits March 18, 2020 12:09
@tomerd
improve readme readability
3e3f163 
motivation: clearer readme

changes:
* fix alignment of bullet points
* add some spaces to break up sentences
@tomerd
fixup
9ec7d1f
@tomerd tomerd merged commit 468a900 into master Mar 18, 2020
@tomerd tomerd deleted the readme branch March 19, 2020 03:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabianfett fabianfett fabianfett approved these changes

+1 more reviewer

@glbrntt glbrntt glbrntt requested changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tomerd @glbrntt @fabianfett