summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 97f4df1..8855318 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,23 @@ This is a demo of how I keep my private journal. In short:
- ikiwiki's [inline][] directive helps collect journal entries
- tags and topic pages help collect
- I have a "topic" for each person
-* [jt][] helps make entries and maintain the journal
+* [jt][] helps make entries and maintain the journal (not necessary,
+ but relieves some tedium)
[ikiwiki]: http://ikiwiki.info/
[inline]: http://ikiwiki.info/ikiwiki/directive/inline/
[jt]: http://git.liw.fi/jt
+
+
+To use:
+
+* install ikiwiki
+* clone this repo
+* edit ikiwiki.setup to set paths appropriately
+* run ikiwiki --setup ikiwiki.setup
+* open the output files in a web browser or sync the files to a web
+ server -- ikiwiki renders static pages, and does not need to be
+ installed on the server
+* create journal entries as notes/YYYY/MM/DD/basename.mdwn -- see
+ examples
+