aboutsummaryrefslogtreecommitdiff
path: root/SETUP.md
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2018-12-01 22:11:44 +0100
committerJonas Smedegaard <dr@jones.dk>2018-12-01 22:11:44 +0100
commit52d2ad6c2cc08782447dd95a295fdbd3f55f440b (patch)
treef6b02cb0df229dfff418672c7ed523eebddeca3c /SETUP.md
parent0d774178d4236711a1255c7c457e9d2135b4dfd1 (diff)
Comply with standard-readme specification.
Diffstat (limited to 'SETUP.md')
-rw-r--r--SETUP.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/SETUP.md b/SETUP.md
index 1b02e0f..811c128 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -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