|
2 | 2 |
|
3 | 3 | ## Features |
4 | 4 |
|
5 | | -### Feature-ABC |
| 5 | +### Add Task |
6 | 6 |
|
7 | | -Description of the feature. |
| 7 | +This feature adds a task (be it a Todo, a Deadline or an Event) to the list. |
8 | 8 |
|
9 | | -### Feature-XYZ |
| 9 | +### Delete Task |
10 | 10 |
|
11 | | -Description of the feature. |
| 11 | +This feature deletes a task from the list. |
| 12 | + |
| 13 | +### Show All Tasks |
| 14 | + |
| 15 | +This feature displays all tasks in the list. |
| 16 | + |
| 17 | +### Mark Task As Done |
| 18 | + |
| 19 | +This feature marks a task as done, indicated by `[x]`. |
| 20 | + |
| 21 | +### Find Task |
| 22 | + |
| 23 | +This feature shows task(s) which contains the keyword given. |
| 24 | + |
| 25 | +### Undo |
| 26 | + |
| 27 | +This feature lets you undo the latest command (works for add, delete and mark as done!) |
12 | 28 |
|
13 | 29 | ## Usage |
14 | 30 |
|
15 | | -### `Keyword` - Describe action |
| 31 | +### `ls` - Show Task |
16 | 32 |
|
17 | | -Describe the action and its outcome. |
| 33 | +This displays all tasks in the list. |
18 | 34 |
|
19 | 35 | Example of usage: |
20 | 36 |
|
21 | | -`keyword (optional arguments)` |
| 37 | +`ls` |
22 | 38 |
|
23 | 39 | Expected outcome: |
24 | 40 |
|
25 | | -Description of the outcome. |
| 41 | +``` |
| 42 | +1. [T][] read |
| 43 | +2. [T][x] write |
| 44 | +3. [E][] movie night (at: 18 Sep 2021) |
| 45 | +``` |
| 46 | + |
| 47 | +### `todo/deadline/event [description] [date and/or time]` - Add Task |
| 48 | + |
| 49 | +This creates a Task in the list. |
26 | 50 |
|
| 51 | +Examples of usage: |
| 52 | + |
| 53 | +`todo [description]` |
| 54 | +`deadline [description] /by [yyyy-MM-dd] [HH:mm]` |
| 55 | +`event [description] /at [yyyy-MM-dd] [HH:mm]` |
| 56 | + |
| 57 | +Expected outcome: |
| 58 | + |
| 59 | +``` |
| 60 | +added: [T][] task |
| 61 | +Now you have 4 tasks in the list. |
27 | 62 | ``` |
28 | | -expected output |
| 63 | + |
| 64 | +### `delete/done [index]` - Delete Task/Mark Task As Done |
| 65 | + |
| 66 | +This deletes a task or marks a task as done. |
| 67 | + |
| 68 | +Examples of usage: |
| 69 | + |
| 70 | +`delete 3` |
| 71 | +`done 2` |
| 72 | + |
| 73 | +Expected outcome: |
| 74 | + |
| 75 | +``` |
| 76 | +Noted. I've removed this task: |
| 77 | +[D][] iP (by: 23:59) |
| 78 | +Now you have 2 tasks in the list. |
| 79 | +``` |
| 80 | + |
| 81 | +### `find [keyword(s)]` - Find Task(s) |
| 82 | + |
| 83 | +This shows task(s) that contain the keyword(s). |
| 84 | + |
| 85 | +Examples of usage: |
| 86 | + |
| 87 | +`find read` |
| 88 | +`find event` |
| 89 | + |
| 90 | +Expected outcome: |
| 91 | + |
| 92 | +``` |
| 93 | +Here are the matching tasks in your list: |
| 94 | +1. [T][] read |
| 95 | +``` |
| 96 | + |
| 97 | +### `undo` - Undo Command |
| 98 | + |
| 99 | +This lets you undo the previous command. (works only for add, delete and mark as done) |
| 100 | + |
| 101 | +Example of usage: |
| 102 | + |
| 103 | +`undo` |
| 104 | + |
| 105 | +Expected outcome: |
| 106 | + |
| 107 | +``` |
| 108 | +You've gone back in time! |
| 109 | +1. [T][] read |
| 110 | +2. [T][x] write |
| 111 | +3. [E][] movie night (at: 18 Sep 2021) |
| 112 | +
|
29 | 113 | ``` |
0 commit comments