This module is still using old README.txt template format so needs to be renamed to README.md file and updated to match template.

Follow the pattern in the README.md template.

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:

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

lostcarpark created an issue. See original summary.

lostcarpark’s picture

Assigned: lostcarpark » Unassigned
Status: Needs work » Needs review

I have updated the readme, and would welcome any feedback.

Tanuja Bohra’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
189.7 KB
176.13 KB
170.78 KB
180.14 KB

Verified the MR5, readme.txt file is converted into readme.md and updated with the right format. Added screenshots for reference, RTBC++.

lostcarpark’s picture

Thank you for the review, Tanuja. I noticed in your screenshots that the question lines of the FAQ weren't displaying in bold, and realised I missed "**" from the end of those lines - fixed now.

lostcarpark’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs review

After looking at some other project READMEs, I've moved the Former Maintainers section to Credits. Also added to Table of contents.

I'm setting back to Needs review. I don't think it needs screenshotting again, just a quick look to confirm it's okay.

lostcarpark’s picture

Tanuja Bohra’s picture

Thanks @lostcarpark for the update. It looks fine, added the screenshots for reference. We can move this to RTBC++.

lostcarpark’s picture

Status: Needs review » Reviewed & tested by the community

  • lostcarpark committed f8b0330a on 2.0.x
    Issue #3368024: Convert README.txt to README.md and adapt to recommended...
lostcarpark’s picture

Status: Reviewed & tested by the community » Fixed

Changes merged. Closing issue.

Status: Fixed » Closed (fixed)

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