Convert README.txt to README.md

Created on 17 January 2025, 3 months ago

Problem/Motivation

The current documentation is provided in a README.txt file, which lacks the enhanced readability and formatting capabilities of Markdown. Modern development workflows prefer README.md for better compatibility with platforms like GitHub and GitLab.

Steps to reproduce

Navigate to the theme/module directory.
Open the README.txt file and observe the plain text format.
Attempt to view the file on a Markdown-supported platform; notice the lack of rendering for headings, links, or code snippets.

Proposed resolution

Remove the existing README.txt file.
Create a new README.md file.
Convert the content from README.txt to Markdown format, including proper headings, lists, links, and code blocks.

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task

Status

Active

Version

1.0

Component

Documentation

Created by

🇮🇳India _utsavsharma

Live updates comments and jobs are added and updated live.

Merge Requests

!1Convert README.txt to README.md
Open
🇮🇳India _utsavsharma
updated 3 months ago

Comments & Activities

Issue created by @_utsavsharma
Merge request !13500474: Renamed .txt file to .md → (Open) created by _utsavsharma
Comment 3 months ago →
🇮🇳India _utsavsharma
Changed to README.txt to README.md.
Please review.
Comment 3 months ago →
🇵🇭Philippines clarkssquared
Hi,

The file is converted to REAME.md, however can we make the README.md contents to follow the Drupal README.md template → Moving to needs work, thanks.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024