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...

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

Raghavendra A M created an issue. See original summary.

raghavendra a m’s picture

Status: Active » Needs review

Committed according to the proposed solution.

Please review it.

anybody’s picture

Status: Needs review » Needs work

@Raghavendra A M thanks, please clean up and add information to the README.md according to https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Just doing a machine job converting a txt file to an md file won't be credited here and I hope nowhere. Please help to improve things by what you can do as thinking human.

Thanks

ressa’s picture

Thanks Raghavendra A M, some things are fine. But like @Anybody commented, there is room for improvement.

tyler36 made their first commit to this issue’s fork.

tyler36’s picture

Status: Needs work » Needs review

- Improved sections as per README.md template

- Table of contents
- Requirements
- Installation
- Configuration

- Added manual line breaks for some longer lines.
- "improved" sponsor links

himanshu_jhaloya’s picture

Assigned: Unassigned » himanshu_jhaloya
himanshu_jhaloya’s picture

Assigned: himanshu_jhaloya » Unassigned

README.md file are looks fine now.

tyler36’s picture

Status: Needs work » Needs review
nupur badola’s picture

Status: Needs review » Reviewed & tested by the community

Patch is working and marking it to RTBC.

anybody’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.