Problem/Motivation

Replace README.txt with README.md

Proposed resolution

Rework the file as-is to use Markdown syntax rather than replacing the content.

CommentFileSizeAuthor
#9 link-readme-screenshot.png113.17 KBManoj Raj.R

Issue fork link-3315915

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

dineshreddymathuku created an issue. See original summary.

Manoj Raj.R made their first commit to this issue’s fork.

damienmckenna’s picture

Issue summary: View changes

Please rework the existing content using Markdown syntax rather than replacing it.

Manoj Raj.R’s picture

@damienmckenna
Ok Checking on it

Manoj Raj.R’s picture

Status: Active » Needs review
dineshreddymathuku’s picture

Status: Needs review » Reviewed & tested by the community

Hi #3 and #4 thanks for your Responce
#5 patch is looks good for me so
changing the status RTBC

damienmckenna’s picture

Status: Reviewed & tested by the community » Needs work

Sorry folks, but there needs to be more work on this beyond renaming the file.

You've both opened and worked on a lot of issues like this for different projects, please put a little more work into them beyond just renaming a file, a plain text file renamed to ".md" is wasted time.

Manoj Raj.R’s picture

StatusFileSize
new113.17 KB

Will check it.
But when we are renaming the Readme file to .md format it automatically detects the Markdown format and adapts according to that.
So we are adding it and verifying in the
Can you please mention which way it can be improved instead of Renaming in the file.

Manoj Raj.R’s picture

Status: Needs work » Needs review

@damienmckenna
Can you please check now.
Have used the format as from the https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Here is a summary of the preferred format for README.md:

Headings in all caps.
Headings underlined with ===/--- to the length of the heading, followed by a blank line.
Two lines prior to headings (except the first one).
Bullets denoted by asterisks (*) with hanging indents.
Numbered lists indented 4 spaces.
Bulleted lists indented 1 space.
Text manually word-wrapped within around 80 cols.

damienmckenna’s picture

Title: Replace README.txt with README.md » Rework README.txt as a Markdown file
Assigned: Unassigned » damienmckenna
Status: Needs review » Needs work

Thank you, that's better.

I'm going to review the document as a whole as there are some other changes I think we should make to make it work better as a Markdown file.

dineshreddymathuku’s picture

Status: Needs work » Needs review

damienmckenna’s picture

Assigned: damienmckenna » Unassigned
Status: Needs review » Fixed
Parent issue: » #3278694: Plan for Link 7.x-1.12

Committed. Thank you.

damienmckenna’s picture

damienmckenna’s picture

  • damienmckenna committed 709843b8 on 7.x-1.x
    Issue #3315915 by Manoj Raj.R, damienmckenna, dineshreddymathuku: Rework...

Status: Fixed » Closed (fixed)

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