Semantic Line Breaks for READMEs?

[rjmk]

Diffing a readme is easier with more rather than fewer line breaks. Markdown only treats line breaks as syntactically significant if there are two in a row or if they are preceded by 2+ spaces. So should we use this: http://rhodesmill.org/brandon/2012/one-sentence-per-line/

[iteles]

If you write readme's with the Preview open beside the .md file, it makes perfect sense. Let's trial it :+1:

The only place I see this going wrong is for people who don't use the Preview option and end up writing crazy long paragraphs because it looks pretty broken up in their .md.

[nelsonic]

@rjmk we already try to do this for our own sanity. but its worth having it explicitly noted somewhere to encourage others to line break. some editors have a faint line at 80 chars to remind people not to over-do the line length.

[iteles]

@rjmk @nelsonic Re: line length, it's going into our 'set up your dev environment' guide https://github.com/dwyl/start-here/issues/53

[nelsonic]

@rjmk would you mind PR-ing this into the main readme? (please/thanks) :+1: (or if you don't have time, let us know...)

[rjmk]

This is issue is being automatically closed as it's more than a year old. Please feel free to reopen it if it's still relevant to your project.

[nelsonic]

We need to add this Markdown section: https://github.com/dwyl/style-guide#markdown so we can refer to it. 👍