Replace README.txt with README.md [#3321391]

We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation

Issue fork copyprevention-3321391

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

3321391-replace-readme.txt-with changes, plain diff MR !2
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

15 November 2022 at 08:02

nitapawar created an issue. See original summary.

Comment #2

15 November 2022 at 08:06

nitapawar opened merge request !2

Comment #3

nitapawar commented 15 November 2022 at 08:07

Status:

Active

» Needs review

Committed to proposed solution!
Please review!

Comment #4

phpsubbarao commented 18 November 2022 at 11:40

Status:

Needs review

» Needs work

@Nita, there is more text gap in the patch, please update it.

Comment #5

22 November 2022 at 15:49

grace_karuna made their first commit to this issue’s fork.

Comment #6

grace_karuna

Mumbai

commented 22 November 2022 at 15:51

Updated the md file @phpsubbarao

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

Headings in all caps.
Headings underlined with ===/--- to the length of the heading, followed by a blank line.
Two lines prior to headings (except the first one).
Bullets denoted by asterisks (*) with hanging indents.
Numbered lists indented 4 spaces.
Bulleted lists indented 1 space.
Text manually word-wrapped within around 80 cols.