aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: cbcafdcd4ec03294be64d00ee1bad91f8097ac5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# 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. Add tasks. `toradora -a "The task I want to add"`
  2. Add tasks with priority. `toradora -a "urgent fix" -p 1`
  3. Add daily tasks (always shown). `toradora -d "morning run"`
  4. Add daily tasks with priority. `toradora -d "read" -p 1`
  5. Complete tasks. `toradora -c 1`
  6. Edit tasks. `toradora -e 1 "The previous task edited"`
  7. Manifest tasks. `toradora`

```
----------------------------------------------
>>> Daily <<<
  [!] 2. read for 30 mins
  [~] 1. morning run

>>> Today's Tasks <<<
  [!] 3. fix the login bug
  [~] 4. write tests
  [ ] 5. update docs

>>> Backlog <<<
  [~] 6. old task from yesterday
----------------------------------------------
```

  8. Show all tasks ever recorded. `toradora -z`

## Priority Levels

| Flag  | Symbol | Meaning |
|-------|--------|---------|
| `-p 1` | `[!]`  | High    |
| `-p 2` | `[~]`  | Medium (default) |
| `-p 3` | `[ ]`  | Low     |

## Notes

The DB is currently stored at `~/.toradora.db`

New columns (`priority`, `daily`) are automatically added to existing databases on first run.