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 colorbox-3315327

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:

About issue forks

Comments

Manoj Raj.R created an issue. See original summary.

Manoj Raj.R opened merge request !25

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Active » Needs review
erikaagp’s picture

erikaagp commented
Status: Needs review » Reviewed & tested by the community

It works to me!

Manoj Raj.R’s picture

Manoj Raj.R commented

@erikaagp
Thanks for taking time to check.

damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Reviewed & tested by the community » Needs work

There needs to be more work done on the README file beyond changing its filename.

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

LeoAlcci’s picture

LeoAlcci commented
Status: Needs work » Reviewed & tested by the community
LeoAlcci’s picture

LeoAlcci commented
Status: Reviewed & tested by the community » Needs review
damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Needs review » Needs work

I think it'd be better to leave the first few lists as plain lists instead of numbered lists.

LeoAlcci’s picture

LeoAlcci commented
Status: Needs work » Needs review

Thanks for the feedback, I changed it to plain lists. Please kindly review it!

erikaagp’s picture

erikaagp commented
Status: Needs review » Reviewed & tested by the community

Good Job! lists looking as plain list, I think this issue is finally solved.

kamlesh kishor jha’s picture

kamlesh kishor jha commented
Assigned: Unassigned » kamlesh kishor jha
kamlesh kishor jha’s picture

kamlesh kishor jha commented
Assigned: kamlesh kishor jha » Unassigned

Fixed some formatting issues in mr according to Readme.md template format.

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

paulmckibben’s picture

paulmckibben
he/him
Primary language English
Location Atlanta, GA
commented

I fixed some typos at the end of README.md, but otherwise it looks good. Merging. Thanks to all involved!

paulmckibben’s picture

paulmckibben
he/him
Primary language English
Location Atlanta, GA
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.