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

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

nitapawar created an issue. See original summary.

nitapawar’s picture

Status: Active » Needs review

Committed according to proposed solution!
Please review!

Nila Hyalij’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed the README.md, The Markdown looks good to me, Adhering to Drupal markdown practices.

Changing status to Reviewed and Tested by Community.

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

  • scott_euser committed 030503d on 8.x-1.x
    Issue #3321819 by nitapawar, scott_euser: Replace README.txt with README...
  • scott_euser committed a9496b9 on 8.x-1.x
    Issue #3321819 by nitapawar, scott_euser: Replace README.txt with README...
paulrad’s picture

Hey, @scotteuser! Consider closing the issue.

astonvictor’s picture

Status: Reviewed & tested by the community » Needs work

astonvictor’s picture

Assigned: nitapawar » astonvictor
Status: Needs work » Fixed

Created a new MR with an updated readme.md file.

astonvictor’s picture

Assigned: astonvictor » Unassigned

Status: Fixed » Closed (fixed)

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