Flesh out README
authorJeff Godin <jgodin@tadl.org>
Fri, 20 Jul 2012 21:01:12 +0000 (17:01 -0400)
committerJeff Godin <jgodin@tadl.org>
Fri, 20 Jul 2012 21:01:12 +0000 (17:01 -0400)
Add info on how to put templates into place on an Evergreen
system.

Signed-off-by: Jeff Godin <jgodin@tadl.org>
README

diff --git a/README b/README
index 15f6cc5..4cdae62 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,20 @@
 TADL Template Toolkit skin
+
+This repository currently contains the TADL template toolkit skin and
+support files.
+
+Focus at present is on the OPAC.
+
+Usage
+=====
+
+These templates can be used by placing them in a directory specified in
+your Apache server's OILSWebTemplatePath variable.
+
+    # Templates will be loaded from the following paths in reverse order.
+    PerlAddVar OILSWebTemplatePath "/openils/var/templates"
+    PerlAddVar OILSWebTemplatePath "/openils/var/templates_tadlskin"
+
+A full copy of the rel_2_2 opac templates has been placed in
+templates_tadlskin for convenience while testing and developing. We'll
+likely remove the unchanged templates at some point.