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

Command icon Show commands

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

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

Comments

nitapawar created an issue. See original summary.

arti_parmar’s picture

Assigned: Unassigned » arti_parmar
arti_parmar’s picture

Status: Active » Needs review
StatusFileSize
new7.12 KB

I have applied a patch for "Replace README.txt with README.md format", kindly review this patch.

nitapawar’s picture

Status: Needs review » Needs work

Changing only file name is not sufficient needs to work on more for md format.

arti_parmar’s picture

Status: Needs work » Needs review
StatusFileSize
new2.49 KB

i have changed in README.md format file. check this patch once more .

Manoj Raj.R’s picture

Status: Needs review » Needs work

@arti_parmar
This doesnot sound like a fix. there is diff changed to md->md.
it should be txt->md.

Manoj Raj.R’s picture

Status: Needs work » Needs review
Manoj Raj.R’s picture

Assigned: arti_parmar » Unassigned
Nila Hyalij’s picture

Status: Needs review » Reviewed & tested by the community

@Manoj Raj.R
Your solution looks good to me.
Moving to RTBC.