commit d30e09af4de2158da43d2a4f6e7fc5d6f0310d9a
parent 04f5c1b7bfe1c2a9cd96730d0716c93c684c3f5b
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Wed, 23 Apr 2014 13:34:41 +0200
change README to be specific for morpheus
Signed-off-by: Hiltjo Posthuma <hiltjo@codemadness.org>
Diffstat:
1 file changed, 13 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
@@ -1,22 +1,28 @@
+What is this?
+=============
+
+These are the source files for the Morpheus Linux site: http://morpheus.2f30.org/
+
+
Usage
-=====
+-----
sh generate.sh
+Copy files in output/ to your virtual host directory.
+
Features
-========
+--------
- Small and simple to understand (I hope).
- Small amount of dependencies, requires a POSIX shell and basic Linux/Unix utilities[1].
- Markdown supported by default[0], easily extendable to add your
\<favorite markup language\>.
-- RSS and Atom output support.
-- Sitemap support (sitemap.xml and urllist.txt).
Pages
-=====
+-----
Pages are defined as shellscripts containing the metadata (see pages/html-example.sh).
The content filename is the basename of the shellscript with the type of markup
@@ -28,13 +34,12 @@ the file generate.sh.
Dependencies
-============
+------------
cat, cut, date, mkdir, printf, read, sed, sh (POSIX), test, tr
References
-==========
+----------
[0] smu - markdown processor: https://github.com/Gottox/smu
-[1] busybox - http://www.busybox.net/