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

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.

emarinho’s picture

Assigned: Unassigned » emarinho

I'll review it.

emarinho’s picture

Assigned: emarinho » Unassigned
Status: Needs review » Reviewed & tested by the community

Everything is okay! Nice job!

Manoj Raj.R’s picture

@emarinho
Thanks for taking time to check.

damienmckenna’s picture

Status: Reviewed & tested by the community » Needs work

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

emarinho’s picture

Assigned: Unassigned » emarinho

Ok! I'll work on it!!

emarinho’s picture

Assigned: emarinho » Unassigned
Status: Needs work » Needs review

Done some minor modifications with the README.md file about Markdown best practices. Please, kindly review it! :)

cinarb’s picture

Assigned: Unassigned » cinarb
cinarb’s picture

Assigned: cinarb » Unassigned
Status: Needs review » Reviewed & tested by the community

I can see the changes asked on the scope of this issue were resolved. Good job @emarinho. Moving to RTBC.

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

energee’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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