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 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:

Comments

Sonal Gyanani created an issue. See original summary.

Sonal Gyanani’s picture

Assigned: Sonal Gyanani » Unassigned
Status: Active » Needs review

Created MR for the issue.
Please review.
Thanks

Bushra Shaikh’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
142.23 KB
153.53 KB

I have successfully reviewed your merge request !2 for drupal version 10.0.2.
README.txt file updated to README.md after applying this patch.
Adding screenshots for the reference.

Can be moved to RTBC +1

lamp5’s picture

Status: Reviewed & tested by the community » Needs work

You have to change the file extension in hook_help.

viren18febs’s picture

Status: Needs work » Needs review
FileSize
462 bytes

I have updated the hook help and added a patch for this, please review.

  • lamp5 committed 5dd5bd1a on 2.0.x authored by Sonal Gyanani
    Issue #3341806: Replace README.txt to README.md and update README.md
    
lamp5’s picture

Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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