README missing

Yesterday (or so) I closed #2514272: Providing usefull information in the README.txt but that was apparently a mistake as you point out.

modules should include a useful README

@volkswagenchick thanks for tagging

The README-file should repeat the synopsis on the project page on Drupal.org.

I prefer README.md (a markdown version). I also created #3004326: Make the Tour UI project page look awesome as the README should repeat ...

@clemens.tolboom I'm attaching a patch that removes the old README.txt and adds a new README.md based on the new Project page.

@banoodle just some notes. Feel free not to spend more time. I can do it on commit.

1. +++ README.md
   @@ -0,0 +1,65 @@
   +## Requirements
   +* [Core Tour](https://www.drupal.org/docs/8/core/modules/tour/overview) module must be enabled.
   

   Let's insert a new line between all headings and the text

2. +++ README.md
   @@ -0,0 +1,65 @@
   +1. Install Tour UI module (`composer require drupal/tour_ui`)
   +2. Enable Tour UI module (this will also enable core Tour module if not already enabled)
   

   Is this numbering the markdown way. I thought all 1.'s suffice?

3. +++ README.md
   @@ -0,0 +1,65 @@
   +    ¶
   

   Whitespace

4. +++ README.md
   @@ -0,0 +1,65 @@
   \ No newline at end of file
   

   Please add a new/empty last line here.

Thanks for reviewing @clemens.tolboom.

I'm attaching the requested revisions. Cheers!

@volkswagenchick we are doing markdown. If your suggestions still hold please add a link to these specs.

@volkswagenchick forget my link request ... you reported this issue :-)

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

If you use Markdown, your file should be named README.md (and use valid Markdown syntax), otherwise it should be named README.txt.

Here is a summary of the preferred format for README.txt:

@volkswagenchick I take the README.md flow where IMHO other rules are valid :-p

I'll try to check against

- https://daringfireball.net/projects/markdown/syntax (my first md encounter reference)
- https://en.support.wordpress.com/markdown-quick-reference/ (better readable)

Will commit (with some edits #8 this week.

For completeness I attached my patch. Committed.

Thanks @banoodle and @volkswagenchick for moving this forward.