Problem/Motivation

This module uses a README.txt file as documentation file. Since drupal.org migrated to Gitlab, which renders a Markdown file as HTML, that file should be replaced by a README.md file that uses the template defined in README.md template.

Proposed resolution

Convert README.txt to REDME.md

CommentFileSizeAuthor
#13 README.md.png194.27 KBkenyoowen

Issue fork better_formats-3389710

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

Madhu Kumar M E created an issue. See original summary.

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

uttam opened merge request !7

uttam’s picture

uttam commented

Please review the MR

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

rohan_singh’s picture

rohan_singh commented

Please review this merge request.

rohan_singh’s picture

rohan_singh commented
Status: Active » Needs review
thakurnishant_06’s picture

thakurnishant_06 commented
Title: Convert README.txt to REDME.md » Replace the README.txt file with the README.md file
Category: Feature request » Task
Priority: Normal » Minor
Issue summary: View changes
Status: Needs review » Needs work
Issue tags: +Novice

Reviewed the MR7 . It does not follow the Drupal Readme.md documentation .
Changing status back to NW.

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

sourabhjain’s picture

sourabhjain
Primary language English
commented
Status: Needs work » Needs review
sourabhjain’s picture

sourabhjain
Primary language English
commented

Attaching the documentation of README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

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

kenyoowen’s picture

kenyoowen commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new README.md.png194.27 KB

Hi thakurnishant_06

I applied and reviewed your MR!7 and confirmed that it follows the README.md template standard, but it has a small spacing issue for better readability and I'll fix it. You can check my screenshot to see the issue.

Thank you

rohan_singh’s picture

rohan_singh commented

@anybody @joseph.olstad @mandclu @dragonwize, This issue has been active for a while now. Can anyone of you kindly look into this?

mandclu’s picture

mandclu commented
Status: Reviewed & tested by the community » Needs work

I appreciate the work to date on this, but the README.md provided by MR!7 only provides part of the instructions currently available in the README.txt.

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

davidjguru’s picture

davidjguru
he/him
Primary language Spanish
Location Seville, Andalusia (Spain)
commented
Status: Needs work » Needs review

A new README file update was committed to the Fork version of the issue.
Please, review.

danrod’s picture

danrod
Location Ottawa
commented

I'm not a maintainer of this module but this README.md looks ok to me, pretty self-explanatory, steps to use are clear and the format is the standard for the README.md files.