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

Nila Hyalij created an issue. See original summary.

ressa’s picture

Status: Active » Needs work

Thanks! Originally, the reason for upper-casing headers was to make headers distinct in txt-format, since it didn't have any other formatting tools.

Since we have ## > h2 formatting available in markdown, we should probably switch to using that, for a more human readable formatting.

So headers could be capitalized, with an initial capital, and not all upper-cased, changing "TRANSLITERATE FILENAMES FOR UPLOADS" to "Transliterate filenames for uploads". The same for "CONTENTS OF THIS FILE", "INTRODUCTION", etc.

ivnish’s picture

I fixing it

  • ivnish committed a3ab117 on 8.x-1.x
    Issue #3321388 by ivnish: Replace README.txt with README.md
    

  • ivnish committed 7194ab6 on 2.0.x
    Issue #3321388 by ivnish: Replace README.txt with README.md
    
ivnish’s picture

Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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