README.txt to README.MD

Created on 8 November 2022, about 2 years ago
Updated 21 June 2024, 6 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

๐Ÿ“Œ Task
Status

Needs review

Version

3.0

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia Naveen Kumar Reddy

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

Merge Requests

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.
  • Status changed to Fixed over 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States markie Albuquerque, NM

    Thanks for the merge request. I have committed it and will start a release plan for the next version.

  • Merge request !3Update README.md โ†’ (Open) created by Manoj Raj.R
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Manoj Raj.R Chennai

    Hi @markie

    There is new change in the Readme file as per Drupal standard.

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

  • Status changed to Needs work 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Getting warning :
    warning: README.md has type 100644, expected 100755

    also , few points needs to corrected.
    1. Text manually word-wrapped within around 80 cols.
    2. Few points are given in table of contents but not explained in details , no section available for them.

    Below are the recommended section-
    Drupal recommends the following README sections:

    Project name and introduction (required)
    Table of contents (optional)
    Requirements (required)
    Recommended modules (optional)
    Installation (required, unless a separate INSTALL.md is provided)
    Configuration (required)
    Troubleshooting & FAQ (optional)
    Maintainers (optional)

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Anjali Mehta โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 11 months ago
  • Status changed to Needs work 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Still getting warning of:
    warning: README.md has type 100644, expected 100755

  • First commit to issue fork.
  • Status changed to Needs review 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sakthi_dev

    Please review updated the permission.

  • Status changed to Needs work 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Still getting the same warning:
    warning: README.md has type 100644, expected 100755

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur
  • Status changed to Needs review 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    I have fixed the issues of review report so now review again.

  • Status changed to Needs work 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    @ravikant
    Still getting the same warning:
    warning: README.md has type 100644, expected 100755

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    @Nupur Badola
    The error is not generating for me.
    and patch is applying as designed.

  • Status changed to Needs review 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    @Nupur Badola
    Lets wait for test by other testers.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia dev16.addweb

    silvi.addweb โ†’ made their first commit to this issueโ€™s fork.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia dev16.addweb

    Hi, I have fixed below phpcs issue in README.md and committed file. Please review it

    modules/custom/livechat/README.md 
    
    PHPCBF RESULT SUMMARY
    -----------------------------------------------------------------------------------------------------------------------------
    FILE                                                                                                         FIXED  REMAINING
    -----------------------------------------------------------------------------------------------------------------------------
    /home/addweb/Drupal8-vagrant/web/web/contribution/d9_contribution2/web/modules/custom/livechat/README.md     1      0
    -----------------------------------------------------------------------------------------------------------------------------
    A TOTAL OF 1 ERROR WERE FIXED IN 1 FILE
    -----------------------------------------------------------------------------------------------------------------------------
    
    Time: 51ms; Memory: 10MB

    And also MR 3 applied cleanly.

    modules/custom/livechat# curl https://git.drupalcode.org/project/livechat/-/merge_requests/3.diff | git apply -v
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100  3653    0  3653    0     0   4077      0 --:--:-- --:--:-- --:--:--  4072
    Checking patch README.md...
    Applied patch README.md cleanly.
    
Production build 0.71.5 2024