diff options
author | Lars Wirzenius <liw@liw.fi> | 2020-03-07 11:41:43 +0200 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2020-03-07 11:41:43 +0200 |
commit | 3c9e7ed7acf14f70f220d1d9c1d6a8afa1d0b3d6 (patch) | |
tree | 99bb5ed91393bef39033d0b1e20a327361fc8ecc | |
parent | b179150efa5ac9c2c922c4e928360cbde7659353 (diff) | |
download | demo-journal-3c9e7ed7acf14f70f220d1d9c1d6a8afa1d0b3d6.tar.gz |
Change: flesh out README a bit more
-rw-r--r-- | README.md | 17 |
1 files changed, 16 insertions, 1 deletions
@@ -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 + |