Replace README.txt with README.md

Created on 3 April 2023, about 1 year ago
Updated 4 August 2023, 11 months 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

2.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 about 1 year ago
  • 🇮🇳India gowthami reddy

    Updated the readme file

    please review it

  • 🇺🇸United States matthand Riverdale Park, Maryland

    Changing to new default branch of 2.x-dev.

  • Status changed to Needs work about 1 year ago
  • 🇧🇷Brazil elber Brazil

    Hi indroduction section needs to be above the "CONTENTS OF THIS FILE" section

    you can use this example as pattern

    # Example Template
    
    The introduction summarizes the purpose and function of the project, and should be concise (a brief paragraph or two). This introduction may be the same as the first paragraph on the project page.
    
    ## Table of contents (optional)
    
    - Requirements
    - Recommended modules
    - Installation
    - Configuration
    - Troubleshooting
    - FAQ
    - Maintainers
    
    ## Requirements (required)
    
    This module requires the following modules:
    - [Bad judgement](https://www.drupal.org/project/bad_judgement)
    
    OR
    
    This module requires no modules outside of Drupal core.
    
    ## Recommended modules (optional)
    
    ## Installation (required, unless a separate INSTALL.md is provided)
    
    Install as you would normally install a contributed Drupal module. For further information, see [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
    
    ## Configuration (required)
    
    1. Enable the module at Administration > Extend.
    2. Profit.
    
    ## Troubleshooting (optional)
    
    ## FAQ (optional)
    
    **Q: How do I write a module README?**
    
    **A:** Follow this template. It's fun and easy!
    
    ## Maintainers (optional)
    
    - Dries Buytaert - [dries](https://www.drupal.org/u/dries)
  • Assigned to nitin_lama
  • @nitin_lama opened merge request.
  • 🇮🇳India nitin_lama

    Providing changes in the MR1. Please review. Thanks.

  • Issue was unassigned.
  • Status changed to Needs review about 1 year ago
  • Status changed to Needs work about 1 year ago
  • 🇵🇭Philippines kenyoOwen

    Hi nitin_lama

    I reviewed and applied MR!1 and confirmed that the README.md is following the README.md template, but there is an existing patch after applying your MR and the README.txt is still present which is redundant to the README.md. Please see the screenshots attached.

    Thank you.

  • Assigned to elber
  • 🇧🇷Brazil elber Brazil

    I will work on it.

  • Issue was unassigned.
  • Status changed to Needs review about 1 year ago
  • 🇧🇷Brazil elber Brazil

    Hi please revise.

  • Status changed to RTBC 12 months ago
  • 🇮🇳India Nupur Badola

    Patch is working and marking it to RTBC.

  • Status changed to Needs review 12 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    There is no provided patch. In this case, the patch is working does not make sense. Even in the case a patch was provided, the fact the patch works is secondary; the most relevant part is whenever the changes are correct.

  • Status changed to Needs work 12 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Assigned to sourabhjain
  • Issue was unassigned.
  • Status changed to Needs review 11 months ago
  • Status changed to RTBC 11 months ago
  • 🇧🇷Brazil elber Brazil

    Hi I reviewed the last changes in the commit.

    README is following drupal standards

    File has all required sections.

    Moving to RTBC

  • Status changed to Needs work 11 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Status changed to Needs review 11 months ago
  • 🇧🇷Brazil elber Brazil

    Hi I just fixed the error mentioned before, please revise

  • Status changed to RTBC 11 months ago
  • 🇧🇷Brazil elber Brazil

    Hi I think ok move to RTBC because all the errors were fixed.

Production build 0.69.0 2024