aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAche <ache@ache.one>2016-05-08 18:18:42 +0200
committerAche <ache@ache.one>2016-05-08 18:18:42 +0200
commit8201dc3e0e43d10c5ebca771cdaee270bb7e145c (patch)
tree9323d7532a9d8b73a75ba3785302affd62827489 /README.md
Init commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa6ca0b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+todo.cpp
+========
+
+Todo list program
+
+Usage : todo [show,add,remove,check,set]
+
+todo use the file named ".todo.txt" in the current dir. So you can use many todo-list, one per directory.
+They have no ID system. For select a task, just type it or a part of it.
+You can add priority for each task "todo add priority task" or "todo set priority task-part"
+To check a task type "todo check todo-part"
+
+If many tasks contains the todo-part, all of it will be selected.
+
+Exemple of how you can use it :
+-------------
+```
+----[ache@ache_arch][~/test][<3]
+----> todo add 1 Read H2G2
+----[ache@ache_arch][~/test][<3]
+----> todo show
+[ ] Read 1984
+[ ] Read H2G2
+----[ache@ache_arch][~/test][<3]
+----> todo -s 1
+[ ] Read H2G2
+----[ache@ache_arch][~/test][<3]
+----> todo -s 4
+[ ] Read 1984
+----[ache@ache_arch][~/test][<3]
+----> todo add Push it on github
+----[ache@ache_arch][~/test][<3]
+----> todo check Read
+----[ache@ache_arch][~/test][<3]
+----> todo
+[✓] Read 1984
+[✓] Read H2G2
+[ ] Push it on github
+----[ache@ache_arch][~/test][<3]
+----> todo remove H2G2
+----[ache@ache_arch][~/test][<3]
+----> todo
+[✓] Read 1984
+[ ] Push it on github
+----[ache@ache_arch][~/test][<3]
+----> todo s 1 github
+[ ] Push it on github
+----[ache@ache_arch][~/test][<3]
+----> todo check git
+----[ache@ache_arch][~/test][<3]
+----> todo
+[✓] Read 1984
+[✓] Push it on github
+```