|
1 | | -# User Guide |
| 1 | +# Duke User Guide |
| 2 | + |
| 3 | +<p align="centre"> |
| 4 | + <img src="./Ui.png" width="400" heigh = "600"> |
| 5 | +</p> |
2 | 6 |
|
3 | 7 | ## Features |
4 | 8 |
|
5 | | -### Feature 1 |
6 | | -Description of feature. |
| 9 | +Duke is a task tracking applications that helps you to keep track of task/events with or without deadline. |
7 | 10 |
|
8 | 11 | ## Usage |
9 | 12 |
|
10 | | -### `Keyword` - Describe action |
| 13 | +### Build and Run |
| 14 | + |
| 15 | +To use Duke, you have to compile and run Duke.java at `src/main/java/duke`. |
| 16 | + |
| 17 | +An alternatives will be using gradle to build and run the application. |
| 18 | + |
| 19 | +A packaged jar file has been attached in the latest release. Feel free to download it. |
| 20 | +To run the jar file, simply type in the command `java -jar Duke.jar` |
| 21 | + |
| 22 | + |
| 23 | +### `todo` - Add a todo task |
| 24 | + |
| 25 | +Add a todo task with your given task content to Duke. |
| 26 | + |
| 27 | +Format: `todo CONTENT` |
| 28 | + |
| 29 | +Example: |
| 30 | +```$xslt |
| 31 | +todo a 2103 individual project |
| 32 | +``` |
| 33 | + |
| 34 | +Expected Outcome: |
| 35 | +```$xslt |
| 36 | +Added liao: [T][ ] 1. a 2103 individual project |
| 37 | +You have 1 task in the list! |
| 38 | +``` |
| 39 | +### `deadline` - Add a deadline task |
| 40 | + |
| 41 | +Add a deadline task with your given task content and deadline(YYYY-MM-DD) to Duke. |
| 42 | + |
| 43 | +Format: `deadline CONTENT/DEADLINE` |
| 44 | + |
| 45 | +Example: |
| 46 | +```$xslt |
| 47 | +deadline team meeting/2021-01-22 |
| 48 | +``` |
| 49 | + |
| 50 | +Expected Outcome: |
| 51 | +```$xslt |
| 52 | +Added liao: [D][ ] 2. team meeting (Jan 22 2021) |
| 53 | +You have 2 tasks in the list! |
| 54 | +``` |
| 55 | + |
| 56 | +### `event` - Add an event |
| 57 | + |
| 58 | +Add an event with the event content and deadline(YYYY-MM-DD) to Duke. |
| 59 | + |
| 60 | +Format: `event CONTENT/DEADLINE` |
| 61 | + |
| 62 | +Example: |
| 63 | +```$xslt |
| 64 | +event Chinese New Year/2021-02-11 |
| 65 | +``` |
| 66 | + |
| 67 | +Expected Outcome: |
| 68 | +```$xslt |
| 69 | +Added liao: [E][ ] 3. Chinese New Year (Feb 11 2021) |
| 70 | +You have 3 tasks in the list! |
| 71 | +``` |
| 72 | + |
| 73 | +### `list` - List all the current tasks |
| 74 | + |
| 75 | +List all the tasks that you have added to Duke. |
| 76 | + |
| 77 | +Format: `list` |
| 78 | + |
| 79 | +Example: |
| 80 | +```$xslt |
| 81 | +list |
| 82 | +``` |
| 83 | + |
| 84 | +Expected Outcome: |
| 85 | +```$xslt |
| 86 | +[T][ ] 1. a 2103 individual project |
| 87 | +[D][ ] 2. team meeting (Jan 22 2021) |
| 88 | +[E][ ] 3. Chinese New Year (Feb 11 2021) |
| 89 | +``` |
| 90 | + |
| 91 | +### `done` - Mark a current task as done. |
| 92 | + |
| 93 | +Mark a current task with the given index as done in Duke. |
| 94 | + |
| 95 | +Format: `done INDEX` |
| 96 | + |
| 97 | +Example: |
| 98 | +```$xslt |
| 99 | +done 1 |
| 100 | +
|
| 101 | +list |
| 102 | +``` |
| 103 | + |
| 104 | +Expected Outcome: |
| 105 | +```$xslt |
| 106 | +Wah~ You done the task: [T][X] 1. a 2103 indivual project |
| 107 | +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - |
| 108 | +[T][X] 1. a 2103 individual project |
| 109 | +[D][ ] 2. team meeting (Jan 22 2021) |
| 110 | +[E][ ] 3. Chinese New Year (Feb 11 2021) |
| 111 | +``` |
| 112 | + |
| 113 | +### `delete` - Delete a current task from Duke. |
| 114 | + |
| 115 | +Delete a task with the given index in Duke. |
| 116 | + |
| 117 | +Format: `delete INDEX` |
| 118 | + |
| 119 | +Example: |
| 120 | +```$xslt |
| 121 | +delete 1 |
| 122 | +kust |
| 123 | +``` |
| 124 | + |
| 125 | +Expected Outcome: |
| 126 | +```$xslt |
| 127 | +Awww~ You've deleted the task: [T][X] 1. a 2103 indiviual project |
| 128 | +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - |
| 129 | +[D][ ] 1. team meeting (Jan 22 2021) |
| 130 | +[E][ ] 2. Chinese New Year (Feb 11 2021) |
| 131 | +``` |
| 132 | + |
| 133 | +### `find` - Find all relevant tasks. |
| 134 | + |
| 135 | +Find all relevent tasks with your given keyword in Duke. |
| 136 | + |
| 137 | +Format: `find KEYWORD` |
| 138 | + |
| 139 | +Example: |
| 140 | +```$xslt |
| 141 | +find meeting |
| 142 | +``` |
| 143 | + |
| 144 | +Expected Outcome: |
| 145 | +```$xslt |
| 146 | +Here are the matches for your search: |
| 147 | +[D][ ] 1. team meeting (Jan 22 2021) |
| 148 | +``` |
| 149 | + |
| 150 | +### `clear` - Clear statistics and history. |
| 151 | + |
| 152 | +Delete user history file. |
| 153 | + |
| 154 | +Format: `clear` |
| 155 | + |
| 156 | +Example: |
| 157 | +```$xslt |
| 158 | +clear |
| 159 | +``` |
| 160 | + |
| 161 | +Expected Outcome: |
| 162 | +```$xslt |
| 163 | +Successfully clear statistics |
| 164 | +(Statistics.txt removed) |
| 165 | +``` |
| 166 | + |
| 167 | +### `bye` - exit Duke |
| 168 | + |
| 169 | +Exit Duke and save your task history. |
| 170 | + |
| 171 | +Format: `bye` |
| 172 | + |
| 173 | +Example: |
| 174 | +```$xslt |
| 175 | +bye |
| 176 | +``` |
| 177 | + |
| 178 | +Expected Outcome: Application Exits |
| 179 | + |
| 180 | + |
| 181 | +## Author |
| 182 | +Huang Zhenxin |
| 183 | + |
| 184 | + |
11 | 185 |
|
12 | | -Describe action and its outcome. |
13 | 186 |
|
14 | | -Example of usage: |
15 | 187 |
|
16 | | -`keyword (optional arguments)` |
17 | 188 |
|
18 | | -Expected outcome: |
19 | 189 |
|
20 | | -`outcome` |
|
0 commit comments