Replace README.txt with README.md

Created on 29 March 2023, over 1 year ago
Updated 23 August 2023, over 1 year ago

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

📌 Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

🇮🇳India gowthami reddy

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @gowthami reddy
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India gowthami reddy

    As per md format updated the readme file

    please review the same

  • First commit to issue fork.
  • @nayana_mvr opened merge request.
  • 🇮🇳India nayana_mvr

    Verified the changes in the branch. There were some format issues which I have corrected in the new commit. Also, updated few more details and created MR!1. Please review. Thanks

  • First commit to issue fork.
  • 🇮🇳India Nupur Badola

    Patch is working but getting the warning.

    warning: README.txt has type 100644, expected 100755
    
  • Status changed to RTBC over 1 year ago
  • 🇵🇭Philippines clarkssquared

    Hi

    I applied the updated MR to my local with Drupal 9.5.9 and I confirmed that it applied cleanly and replaced REAMDE.txt with README.md, and below is the result that is showing in my terminal as I apply the MR

    % Total % Received % Xferd Average Speed Time Time Time Current
    Dload Upload Total Spent Left Speed
    100 3874 0 3874 0 0 4142 0 --:--:-- --:--:-- --:--:-- 4215
    Checking patch README.md...
    Checking patch README.txt...
    Applied patch README.md cleanly.
    Applied patch README.txt cleanly.

    Please also look at the screenshots attached for reference.

    Thank you

  • Status changed to Needs work over 1 year ago
  • 🇮🇳India rushiraval

    Text in readme.md file exceeding the 80 text in line limit. It should be limite as per REadme.md Template guidelines

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

  • First commit to issue fork.
  • Status changed to Needs review over 1 year ago
  • Status changed to RTBC over 1 year ago
  • 🇮🇳India rushiraval

    I have reviewed readme.md file of MR!1. It is as per required format.
    so I am moving this isssue to RTBC.

Production build 0.71.5 2024