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 the pattern in the README.md template.

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

phpsubbarao created an issue. See original summary.

Naveen Kumar Reddy made their first commit to this issue’s fork.

Naveen Kumar Reddy’s picture

Status: Active » Needs review

Hi
As per markdown we changed README.txt to README.md please review it.

Thank you

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

Manoj Raj.R’s picture

Made some minor updates which are respect to the markdown format.

Other than everything looks good to me.

Please review it

Can be moved to RTBC.

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

grace_karuna’s picture

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.

ressa’s picture

Issue summary: View changes
Status: Needs review » Needs work

Thanks, please follow the pattern in the README.md template.

marcoka’s picture

Renamed to *.md.
As this is in development and changing the rest has to be postphoned until everything is stable and solid to document.

nitin_lama’s picture

Assigned: Unassigned » nitin_lama
nitin_lama’s picture

Assigned: nitin_lama » Unassigned

ravi kant made their first commit to this issue’s fork.

ravi kant’s picture

Updated MR according README template

Anjali Mehta made their first commit to this issue’s fork.

anjali mehta’s picture

Status: Needs work » Needs review
kenyoowen’s picture

Status: Needs review » Needs work

Hi Anjali Mehta

I reviewed MR!2 and the '### Problems' text where CKEditor doesn change doesn to doesn't.

Thank you

nitin_lama’s picture

Assigned: Unassigned » nitin_lama
nitin_lama’s picture

Status: Needs work » Needs review
nitin_lama’s picture

Assigned: nitin_lama » Unassigned
nupur badola’s picture

Status: Needs review » Needs work

Reviewed MR!2, getting the warning mentioned below:

warning: README.md has type 100644, expected 100755

ravi kant changed the visibility of the branch 1.1.x to hidden.

ravi kant changed the visibility of the branch 3322464-replace-readme.txt-with to hidden.

ravi kant’s picture

Status: Needs work » Needs review

Created new MR !3.

marcoka’s picture

Don´t put so much work and effort in a readme of a beta module. The docs are not even solid yet.