Replace README.txt with README.md file

Created on 7 January 2023, almost 2 years ago
Updated 2 November 2023, about 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 the pattern in the README.md template .

📌 Task
Status

Needs work

Version

1.0

Component

Documentation

Created by

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.

  • First commit to issue fork.
  • @nayana_mvr opened merge request.
  • Issue was unassigned.
  • Status changed to Needs review almost 2 years ago
  • 🇮🇳India nayana_mvr

    As there were no changes in MR!1, I have created a new MR with the required changes. Please review.

  • 🇮🇳India Nupur Badola

    Error in patch.

    2.diff.txt:9: trailing whitespace.
    The Configuration Overview module is intended to help to understand how the
    warning: README.txt has type 100644, expected 100755
    warning: 1 line adds whitespace errors.
  • Status changed to Needs work about 1 year ago
  • 🇮🇳India Nupur Badola

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

    1. Sponsors should not come under Maintainer section.
    2. Text "Current Maintainer" is not required as in Maintainer section only current maintainers are listed.
    3. If No requirements are given , then it should be written like this : 
    This module requires no modules outside of Drupal core.
    4. If no configuration is given, then it be written like this: 
    The module has no menu or modifiable settings. There is no configuration. When
    enabled, the module will prevent the links from appearing. To get the links
    back, disable the module and clear caches.
Production build 0.71.5 2024