aboutsummaryrefslogtreecommitdiff
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
parent0d774178d4236711a1255c7c457e9d2135b4dfd1 (diff)
Comply with standard-readme specification.
-rw-r--r--README.md24
-rw-r--r--SETUP.md9
2 files changed, 29 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3da25e3..18e3f83 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
-# Organisational structure of feature projects
+# System feature organisation _(org)_
+
+> Organisational structure of feature projects
A feature contains texts and scripts,
each targeting one of 3 audiences:
Decision makers, users, users, and technicians.
As a minimum,
-each feature contains an executive summary text.
+each feature contains an general README text.
A feature may start as a personal draft,
and ideally ends as globally reusable and long-term maintained.
@@ -14,3 +16,21 @@ and a mature feature can be shadowed by a local adaptation.
Features are compiled together
globally and for each site,
presenting features as one coherent documentation bundle.
+
+
+## Contributing
+
+Feel free to dive in!
+
+Make your proposed changes to a fork of the source git,
+and tell us where we can get your fork.
+
+For now "we" is me, Jonas Smedegaard, with email <mailto:dr@jones.dk>.
+
+
+## License
+
+[CC BY-SA][] Jonas Smedegaard <dr@jones.dk>
+
+[CC BY-SA]: <https://creativecommons.org/licenses/by-sa/4.0/>
+ "Creative Commons Attribution-ShareAlike 4.0 International license"
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