From 3c9e7ed7acf14f70f220d1d9c1d6a8afa1d0b3d6 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 7 Mar 2020 11:41:43 +0200 Subject: Change: flesh out README a bit more --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'README.md') 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 + -- cgit v1.2.1