The markdown format is now the recommended format for README-files.

Issue fork customerror-3327195

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
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

gisle created an issue. See original summary.

ressa’s picture

ressa CreditAttribution: ressa at Ardea commented

Two nice FAQ examples, for possible inspiration:

  • gisle authored a0e2de4 on 8.x-1.x 
    Issue #3327195 by gisle: Replaced README.txt with README.md
gisle’s picture

gisle
he/him
Primary language Norwegian Bokmål
Location Norway
CreditAttribution: gisle at Hannemyr Nye Medier AS for Ramsalt Lab commented
Assigned: gisle » Unassigned
Status: Active » Fixed

Thanks for the examples, ressa.

A README.md is now committed against the HEAD of 8.x-1x-dev.

ressa opened merge request !2

ressa’s picture

ressa CreditAttribution: ressa at Ardea commented
Status: Fixed » Needs review

Thanks, it looks great @gisle.

A minor thing is the line break in the list under "Configuration:" (number 3.), which adds space in the rendered list. Also, in some lines there are three spaces, not four, some headers also have a colon. I have created a MR which updates these issues.

  • gisle committed c1373945 on 8.x-1.x authored by ressa 
    Resolve #3327195 "Change readme.txt to"
gisle’s picture

gisle
he/him
Primary language Norwegian Bokmål
Location Norway
CreditAttribution: gisle at Hannemyr Nye Medier AS for Ramsalt Lab commented
Issue summary: View changes
Status: Needs review » Fixed

Merge request !2 committed.

Status: Fixed » Closed (fixed)

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