diff options
authorLars Wirzenius <>2020-03-07 11:41:43 +0200
committerLars Wirzenius <>2020-03-07 11:41:43 +0200
commit3c9e7ed7acf14f70f220d1d9c1d6a8afa1d0b3d6 (patch)
parentb179150efa5ac9c2c922c4e928360cbde7659353 (diff)
Change: flesh out README a bit more
1 files changed, 16 insertions, 1 deletions
diff --git a/ b/
index 97f4df1..8855318 100644
--- a/
+++ b/
@@ -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)
+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