diff options
author | Jonas Smedegaard <dr@jones.dk> | 2018-12-01 22:11:44 +0100 |
---|---|---|
committer | Jonas Smedegaard <dr@jones.dk> | 2018-12-01 22:11:44 +0100 |
commit | 52d2ad6c2cc08782447dd95a295fdbd3f55f440b (patch) | |
tree | f6b02cb0df229dfff418672c7ed523eebddeca3c /SETUP.md | |
parent | 0d774178d4236711a1255c7c457e9d2135b4dfd1 (diff) |
Comply with standard-readme specification.
Diffstat (limited to 'SETUP.md')
-rw-r--r-- | SETUP.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -7,7 +7,7 @@ A feature contains texts and scripts, each targeting one of 3 audiences: 1. Decision makers - + Summary text: file `README.md` + + General README text: file `README.md` + Overview text: file `OVERVIEW.md` 2. Users + Getting started text: `INTRO.md` @@ -18,9 +18,14 @@ each targeting one of 3 audiences: + Maintainance text: file `ADMIN.md` + Administration scripts -Summary text is mandatory. +General README text is mandatory, +and must follow the [standard-readme][] specification. + All other parts are optional. +[standard-readme]: <https://github.com/RichardLitt/standard-readme/blob/master/spec.md> + "specification for how a standard README should look" + ## Maturity |