|
2 | 2 |
|
3 | 3 | ## Features |
4 | 4 |
|
5 | | -### Feature 1 |
6 | | -Description of feature. |
| 5 | +### Add tasks (ToDos, Deadlines, Events) |
| 6 | +You can add 3 types of tasks to MyDuke: |
| 7 | + |
| 8 | +**ToDo** - General tasks with no specific deadline |
| 9 | + |
| 10 | +**Deadline** - Tasks with a specific do-by date and time |
| 11 | + |
| 12 | +**Event** - Matters to attend to at a specific date and time |
| 13 | + |
| 14 | +Number of tasks will be updated and shown upon each addition |
| 15 | +of tasks. |
| 16 | + |
| 17 | +### Show task list |
| 18 | +You can list all the tasks stored in MyDuke. |
| 19 | + |
| 20 | +### Mark tasks as done |
| 21 | +You can mark a task as done upon completion. |
| 22 | + |
| 23 | +### Search for tasks |
| 24 | +You can search (a) task(s) using keywords, MyDuke will show |
| 25 | +a list of all tasks matching the keyword. |
| 26 | + |
| 27 | +### Sort tasks by alphabetical order |
| 28 | +You can sort and reorder the tasks in alphabetical order. |
| 29 | + |
| 30 | +### Save task |
| 31 | +You can save the current tasks on MyDuke, which will be saved |
| 32 | +as a txt file that can be read the next time MyDuke is launched. |
7 | 33 |
|
8 | 34 | ## Usage |
9 | 35 |
|
10 | | -### `Keyword` - Describe action |
| 36 | +### `todo` - Add a new ToDo Task |
11 | 37 |
|
12 | | -Describe action and its outcome. |
| 38 | +Adds a new ToDo Task to MyDuke. |
| 39 | + |
| 40 | +_input: todo [description]_ |
13 | 41 |
|
14 | 42 | Example of usage: |
15 | 43 |
|
16 | | -`keyword (optional arguments)` |
| 44 | +`todo play football` |
| 45 | + |
| 46 | +Expected outcome: |
| 47 | + |
| 48 | +`ok i just help u added this todo -- [T][ ] play football. now u got 1 item(s) in your list ah` |
| 49 | + |
| 50 | +### `Deadline` - Add a new Deadline Task |
| 51 | +Adds a new Deadline Task to MyDuke. |
| 52 | + |
| 53 | +_input: deadline [description] /by [YYYY-MM-DD]_ |
| 54 | + |
| 55 | +Example of usage: |
| 56 | + |
| 57 | +`deadline CS1010S submission /by 2020-06-06` |
| 58 | + |
| 59 | + |
| 60 | +Expected outcome: |
| 61 | + |
| 62 | +`ok i just help u added this event -- [D][ ] CS1010S submission (JUN 06 2020) |
| 63 | +. now u got 2 item(s) in your list ah` |
| 64 | + |
| 65 | +### `Event` - Add a new Event Task |
| 66 | +Adds a new Event Task to MyDuke. |
| 67 | + |
| 68 | +_input: event [description] /by [YYYY-MM-DD]_ |
| 69 | + |
| 70 | +Example of usage: |
| 71 | + |
| 72 | +`event Staraptor Birthday /by 2020-02-03` |
| 73 | + |
| 74 | + |
| 75 | +Expected outcome: |
| 76 | + |
| 77 | +`ok i just help u added this event -- [E][ ] Staraptor Birthday (FEB 03 2020) |
| 78 | +. now u got 3 item(s) in your list ah` |
| 79 | + |
| 80 | +### `list` - list all Tasks |
| 81 | +Adds a new Event Task to MyDuke. |
| 82 | + |
| 83 | +_input: event [description] /by [YYYY-MM-DD]_ |
| 84 | + |
| 85 | +Example of usage: |
| 86 | + |
| 87 | +`list` |
| 88 | + |
| 89 | +Expected outcome: |
| 90 | + |
| 91 | +`1. [T][ ] play football` |
| 92 | + |
| 93 | +`2. [D][ ] CS1010S submission (JUN 06 2020)` |
| 94 | + |
| 95 | +`3. [E][ ] Staraptor Birthday (FEB 03 2020)` |
| 96 | + |
| 97 | +### `done` - mark a Task as done |
| 98 | +Marks the task at the specified index as done. |
| 99 | + |
| 100 | +_input: done [index]_ |
| 101 | + |
| 102 | +Example of usage: |
| 103 | + |
| 104 | +`done 2` |
| 105 | + |
| 106 | +Expected outcome: |
| 107 | + |
| 108 | +`ok i just help u checked this task as done -- [D][X] CS1010S submission (JUN 06 2020)` |
| 109 | + |
| 110 | +### `delete` - delete a Task |
| 111 | +Deletes the task at the specified index as done. |
| 112 | + |
| 113 | +_input: delete [index]_ |
| 114 | + |
| 115 | +Example of usage: |
| 116 | + |
| 117 | +`delete 1` |
| 118 | + |
| 119 | +Expected outcome: |
| 120 | + |
| 121 | +`ok i just help u deleted this task -- [T][ ] play football.` |
| 122 | + |
| 123 | +### `find` - find a Task using a keyword |
| 124 | +Finds and displays the task that matches the keyword (case-sensitive) |
| 125 | + |
| 126 | +_input: find [keyword]_ |
| 127 | + |
| 128 | +Example of usage: |
| 129 | + |
| 130 | +`find Staraptor` |
| 131 | + |
| 132 | +Expected outcome: |
| 133 | + |
| 134 | +`dis is your search result for 'Staraptor'` |
| 135 | + |
| 136 | +`1. [E][ ] Staraptor Birthday (FEB 03 2020)` |
| 137 | + |
| 138 | +### `sort` - sort Task list by alphabetical order |
| 139 | +Sorts the list in alphabetical order. (Input list to view list after sorting) |
| 140 | + |
| 141 | +_input: sort_ |
| 142 | + |
| 143 | +Example of usage: |
| 144 | + |
| 145 | +`sort` |
| 146 | + |
| 147 | +Expected outcome: |
| 148 | + |
| 149 | +`Ok can limpeh help u sort your list according to alphabetical order liao` |
| 150 | + |
| 151 | +### `bye` - Saves tasks to storage |
| 152 | +Saves all tasks in MyDuke to local storage. You may now close the app. |
| 153 | + |
| 154 | +_input: bye_ |
| 155 | + |
| 156 | +Example of usage: |
| 157 | + |
| 158 | +`bye` |
17 | 159 |
|
18 | 160 | Expected outcome: |
19 | 161 |
|
20 | | -`outcome` |
| 162 | +`Leave so soon ah? Ok can limpeh help u save your list in [root]/data as saveFile.txt, i go sleep first` |
0 commit comments