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.

Follow this pattern

https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

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

Raghavendra A M created an issue. See original summary.

raghavendra a m’s picture

Status: Active » Needs review

Committed according to the proposed solution.

Please review it.

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

Pracheth’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed the README.md (latest MR! by Raghavendra A M #2), which needed some minor changes on markdown formatting .
Committed the changes to the issue fork, Now the Markdown looks good to me(https://git.drupalcode.org/issue/media_gallery-3322118/-/blob/3322118-re...), Adhering to Drupal markdown practices.

Changing status to Reviewed and Tested by Community.

ivnish’s picture

Thanks!

  • ivnish committed f3114ac on 2.0.x
    Issue #3322118 by Raghavendra A M, Pracheth, ivnish: Replace README.txt...
ivnish’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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