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

  1. Navigate to the theme/module directory.
  2. Open the README.txt file and observe the plain text format.
  3. 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.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024