README.md does not follow best practices

You could write a patch following https://www.drupal.org/node/707484 or write it in this issue as a comment?

Until such time that we have community standards for README.MD files, this is in line with what automated testing identifies. For review.

@Webbeh thanks for this patch.

this is in line with what automated testing identifies

Can you please tell me to learn how I can reproduce this.

Is your patch valid markdown? Esp. the lists concerns me. iirc no space for list except list subitems.

I believe the automated tests just look for header lines as outlined in #2181737 - two blank lines above, one below - with headers all in caps.

There's a big asterisks with this page as it applies primarily to README.TXT and not exactly .MD files, so I leave that to y'all to determine if these changes are acceptable.

Is your patch valid markdown? Esp. the lists concerns me. iirc no space for list except list subitems.

Please feel free to interdiff and apply an extra patch to fix any oddities, as I did not do a thorough Markdown check.

Un-assigning original issuer, and marking needs work for:

Is your patch valid markdown? Esp. the lists concerns me. iirc no space for list except list subitems.

https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

If you prefer the patch to follow the existing README.txt best-practices, I'm happy to standardize spacing and hard-wraps and submit a new patch, @clemens.tolboom .

I don't know how we got this README.md in the first place. Found the README.txt template.

If you prefer the patch to follow the existing README.txt best-practices, I'm happy to standardize spacing and hard-wraps and submit a new patch

@Webbeh please do so :-)

Argh ... further down that page https://www.drupal.org/docs/develop/documenting-your-project/readme-temp... it is OK to have markdown format to.

Let's keep the markdown then. But make it valid markdown :)

or a format recognized by the Markdown filter module.

The project page text came from #3004326-9: Make the Tour UI project page look awesome ... not sure we need to align texts?

Let's keep the markdown then. But make it valid markdown :)

As of right now, we don't have a standard Markdown formatting preference. There's work to address this (#2506415: Adopt Markdown for README.txt and other documentation), but it's necessitated by other issues to resolve (#2952616: Adopt CommonMark spec for Markdown files and #3012906: Add Markdown to list of module documentation file types). Until then, we can assume author preferences until the community reaches a direction/consensus.

Will update in another ticket.

Thanks!