summaryrefslogtreecommitdiffstats
path: root/office/todo.txt-cli/README
diff options
context:
space:
mode:
Diffstat (limited to 'office/todo.txt-cli/README')
-rw-r--r--office/todo.txt-cli/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/office/todo.txt-cli/README b/office/todo.txt-cli/README
new file mode 100644
index 0000000000..5dbb331bc2
--- /dev/null
+++ b/office/todo.txt-cli/README
@@ -0,0 +1,13 @@
+A simple and extensible shell script for managing your todo.txt file.
+
+After installing the package, copy the default config file to your home
+directory and adjust it accordingly, otherwise todo.txt-cli will
+misbehave:
+
+$ mkdir ~/.todo
+$ cp /etc/todo.cfg ~/.todo/config
+$ mkdir ~/todo
+
+Then edit ~/.todo/config:
+
+export TODO_DIR=/home/$USER/todo