summaryrefslogtreecommitdiffstats
path: root/nikola/data/samplesite/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'nikola/data/samplesite/README.txt')
-rw-r--r--nikola/data/samplesite/README.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/nikola/data/samplesite/README.txt b/nikola/data/samplesite/README.txt
new file mode 100644
index 0000000..ca94b34
--- /dev/null
+++ b/nikola/data/samplesite/README.txt
@@ -0,0 +1,31 @@
+How To make This Work
+---------------------
+
+The full manual is in stories/manual.txt, but here is the very short version:
+
+1. Install docutils (http://docutils.sourceforge.net)
+2. Install Mako (http://makotemplates.org)
+3. Install doit (http://python-doit.sourceforge.net)
+4. Install PIL (http://www.pythonware.com/products/pil/)
+5. Install Pygments (http://pygments.org/)
+6. Install unidecode (http://pypi.python.org/pypi/Unidecode/)
+7. Install lxml (http://lxml.de/)
+
+To build or update the demo site run this command in the nikola's folder::
+
+ doit
+
+To see it::
+
+ doit serve -p 8000
+
+And point your browser to http://localhost:8000
+
+Notes on Requirements
+---------------------
+
+If you don't have PIL, then image galleries will be inefficient because Nikola
+will not generate thumbnails. Alternatively, you may install pillow instead of
+PIL.
+
+If you don't have pygments, the code-block directive will not highlight syntax.