GopherProxy

	README: update with usage information, thanks kroovy! - saait - the most boring…
	git clone git://git.codemadness.org/saait
	Log
	Files
	Refs
	README
	LICENSE
	---
	commit c7b6ea2a151c146932e814cd20b9d925323a9525
	parent ecfb78c5e243081f78832d0d23ba08a70373d320
	Author: Hiltjo Posthuma <[email protected]>
	Date: Sun, 13 Aug 2017 14:05:39 +0200

	README: update with usage information, thanks kroovy!

	saait has a user now \o/

	applied with a few minor modifications.

	thanks kroovy!: https://kroovy.de/

	Diffstat:
	M README \| 33 +++++++++++++++++++++++++++++…

	1 file changed, 32 insertions(+), 1 deletion(-)
	---
	diff --git a/README b/README
	@@ -45,7 +45,7 @@ See config.h to modify the templates.
	Cfg file and template syntax:
	-----------------------------

	-Variables set:
	+Special variables set:
	htmlfile (if not already set) path to input HTML content filename.
	filename (can be overwritten) basename of output content HTML file.

	@@ -54,3 +54,34 @@ Variables:
	${} escaped HTML/XML string.
	#{} literal string.
	%{} insert contents of file of variable value.
	+
	+
	+Usage:
	+------
	+
	+1. Adjust the global config.cfg file which provides defaults for all pages.
	+2. Call saait from a directory that is providing a config.cfg and a
	+ templates folder. Those are included in the source, so simply call it from
	+ the source directory.
	+3. For each .cfg file there has to be a corresponding .html file with the
	+ same basename. They have to be placed in the same folder.
	+ optionally they can be overridden with the special variable "htmlfile".
	+4. Saait is called naming an output directory and providing one or more *.cfg
	+ files as parameters.
	+5. Modify the following two template files, in order to change the items
	+ displayed in the header (Blog, Git, Github, etc...):
	+
	+ templates/page/header.html
	+ templates/index.html/header.html
	+
	+
	+Usage examples:
	+---------------
	+
	+this is a basic example:
	+
	+ $ saait -o /path/to/www /path/to/001-example.cfg
	+
	+this is an example for how it's used in practice and for many pages:
	+
	+ $ saait -o /path/to/www /path/to/*.cfg