aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..55776d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# toradora - A terminal based todo list
+
+## Getting started
+
+**Requirements**
+
+1. sqlite library
+2. make
+3. gcc/clang
+
+**Compiling**
+
+```bash
+make
+```
+
+**Installing**
+
+```bash
+make install
+```
+
+**Uninstalling**
+
+``` bash
+make uninstall
+```
+
+## /** FEATURES **/
+ 1. Able to add tasks. (toradora -a "The task I want to add")
+ 2. Able to complete those tasks. (toradora -c 1 )
+ 3. Able to edit those tasks. (toradora -e 1 "The previous task edited")
+ 4. Able to manifest those tasks. (toradora)
+ > ===============================
+ > >>> Today's Task <<<
+ > 1. "task one"
+ > 2. "task two"
+
+ > >>> Backlogs <<<
+ > 3. "task three"
+ > ===============================
+ 5. Able to manifest all the tasks in database. (toradora -z)
+
+## Notes
+
+The DB is currently stored at `~/.toradora.db`