commit 3d70bf6284996a5308b8f952cbeef37758ea4c3b
parent 12209344e50cbd5cc692644eb405486912258ecd
Author: parazyd <parazyd@dyne.org>
Date: Fri, 17 Jun 2016 11:40:31 +0200
add documentation
Diffstat:
| A | README.md | | | 42 | ++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 42 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+mars
+----
+superminimal static website framework
+
+## intro
+mars is imagined as a helper to generate static html pages out of your php
+scripts. you are supposed to drop the files in this repository in the root of
+the website where you manage your php scripts and use the provided makefile.
+
+## configuration
+edit the `webtree` file to reflect the directory tree of your website. the file
+is commented with an example. also configure your webhost and the path to your
+webroot so rsync can know where to go.
+
+the `exclude` array is an array of (php) files you don't want to be processed.
+
+the `rsync-exclude` file contains the list of things for rsync to ignore.
+
+## usage
+after you've configured your `webtree`, you are ready to generate the website.
+there are only two steps:
+
+```
+; make # will process your webtree and generate html
+; make push # will rsync the goods to your webserver
+```
+
+an optional third step will delete the html files from the webtree
+
+```
+; make clean
+```
+
+## example/ explained
+the `example` directory shows you how i personally use mars.
+
+`index.php` is the only thing that is being generated as `index.html`
+
+mars will process it, and as it's in php, `footer`, `header` and `navigation`
+are included from `index.php` and get included in the final page. this makes it
+very easy to manage your content, as the only part you actually have to worry
+about in `index.php` is the content (text).
