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
#13 Readme-change.png246.24 KBarunkumark
#7 README.md1.13 KBrohitsharma401

Issue fork commerce_guest_registration-3315381

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:

About issue forks

Comments

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

Manoj Raj.R opened merge request !3

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Active » Needs review

Committed in accordance to the stated requirement.

Manoj Raj.R’s picture

Manoj Raj.R commented
Version: 2.0.1 » 8.x-1.x-dev
damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Needs review » Needs work

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

rohitsharma401’s picture

rohitsharma401 commented
Assigned: Unassigned » rohitsharma401

I am working on this

rohitsharma401’s picture

rohitsharma401 commented
Assigned: rohitsharma401 » Unassigned
Status: Needs work » Needs review
StatusFileSize
new README.md1.13 KB

Changed file format with required md format.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs review » Needs work

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

I will work on this.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs work » Needs review

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

arunkumark’s picture

arunkumark
Location Coimbatore
commented
Status: Needs review » Needs work
Issue tags: +Novice, +Update README.md file

The Readme.md is not fully completed. A few points need work. The template for the Readme.md is here

  1. Configuration details missing
  2. Requirements - Commerce module link not available
  3. Maintainers - Information missing

Keeping Needs work to address above issues.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs work » Needs review

Addressed all the above issues.

Please review.

arunkumark’s picture

arunkumark
Location Coimbatore
commented
StatusFileSize
new Readme-change.png246.24 KB

The updates look good. Attached is the screenshot for reference.

Update

arunkumark’s picture

arunkumark
Location Coimbatore
commented
Status: Needs review » Reviewed & tested by the community
arunkumark’s picture

arunkumark
Location Coimbatore
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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