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

CommentFileSizeAuthor
#6 README.md1.71 KBrohitsharma401
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

Manoj Raj.R created an issue. See original summary.

Manoj Raj.R’s picture

Status: Active » Needs review

Committed in accordance to the stated requirement.

damienmckenna’s picture

Status: Needs review » Needs work

There needs to be more work done on the README file beyond changing its filename.

rohitsharma401’s picture

Assigned: Unassigned » rohitsharma401

I am working on this issue

rohitsharma401’s picture

Assigned: rohitsharma401 » Unassigned
Status: Needs work » Needs review
StatusFileSize
new1.71 KB

Changed the format of file as per the md file format.

Manoj Raj.R’s picture

Status: Needs review » Needs work

@rohitsharma401
As per #4 we need to format as markdown format, not attaching the same Readme file here.

I will work on this.

Manoj Raj.R’s picture

Status: Needs work » Needs review

Here comes the changes as expected by #4 as Markdown syntax.
Please review It!

Sonal Gyanani made their first commit to this issue’s fork.

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

rohan-sinha’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed the MR !5, Readme.txt file has been removed, Readme.md has been added with all the Drupal Documentation Coding Standards being followed, ready to be merged.

Raphael Apard made their first commit to this issue’s fork.

raphael apard’s picture

Status: Reviewed & tested by the community » Fixed

Thanks !

raphael apard’s picture

Status: Fixed » Closed (fixed)