From 52d2ad6c2cc08782447dd95a295fdbd3f55f440b Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Sat, 1 Dec 2018 22:11:44 +0100 Subject: Comply with standard-readme specification. --- SETUP.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'SETUP.md') 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]: + "specification for how a standard README should look" + ## Maturity -- cgit v1.2.3