Replace README.txt with README.md

Created on 16 November 2022, over 2 years ago
Updated 29 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

Component

Miscellaneous

Created by

🇮🇳India raghavendra a m

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

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇮🇳India Nupur Badola

    Reviewed MR!1, the patch is not applied cleanly.

    file is not as per the readme.md file format. Please refer to this page.
    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template
  • Status changed to Needs work over 1 year ago
  • 🇮🇳India rushiraval

    I have reviewed MR!1 manually. Readme.md file still not as per for Drupal Recommendation.

    • Project name is the first line of the document, and only level one heading (#)
    • Two lines prior to ##/### headings
    • Recommeded Sections mission

    Please refer 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
  • 🇧🇷Brazil elber Brazil

    Hi I fixed some whitespaces errors and added obrigatories sections.Please revise.

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

    Still needs some works

    • Two lines prior to ##/### headings
    • ## INTRODUCTION title should be removed
    • Headings capitalized with an initial capital, following standard English sentence rules
  • Assigned to nitin_lama
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • Status changed to RTBC over 1 year ago
  • 🇧🇷Brazil elber Brazil

    Hi I reviewed.

    Changes were applied cleanly.
    Readme is good to me, all the required sections are following drupal standards.

    Moving to RTBC.

Production build 0.71.5 2024