From 82d5299be1073984643da97809a572bfaeefe543 Mon Sep 17 00:00:00 2001 From: Andrei Karas Date: Mon, 11 Apr 2016 20:29:33 +0300 Subject: Add readme. --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..db233fe --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +PagesIndexGen v0.1 + +## Intro + +This is simple site index generator with templates. +It can be used in gitlab pages. + +## Usage + +~~~ +./pagesindexgen.py filedir sitedir template +~~~ + +Any parameters can be avoided. + +## Examples + +This examples is same: + +~~~ +./pagesindexgen.py +./pagesindexgen.py . +./pagesindexgen.py . / +./pagesindexgen.py . / default +~~~ + +## Demo site directory + +In source included demo directory with some files and script to run build. + + +## Url + + - [Home page](https://gitlab.com/4144/pagesindexgen) -- cgit v1.2.3-60-g2f50