Duke user guide
Table of contents
1. General Information
1.1 System overview
1.2 Organization of READ.me
2. Getting Started
2.1 Installation of Duke
2.2 System commands
3. Special Instruction for Error Correction
3.1 Exception handling
3.2 Help page
4. Feedback and Contact us
4.1 Contact us
4.2 Special thanks
1. General Information
1.1 System overview
Welcome to Duke! Duke acts as your trusty online secretary where he helps you to keep track of all your key dates for all your important events. These tasks that you have can be classified into To Do, Events and Deadline tasks. There are also other features that Duke can do for your convenience. Get your very own Duke today!
1.2 Organization of READ.me
The user’s manual consists of 4 sections: General Information, Getting Started, Special Instruction for Error Correction and Feedback and Contact us.
| Section | Description |
|---|---|
| General Information | Gives a broad overview of what Duke does and the purpose for which it is intended. |
| Getting started | Instructions to installing Duke and the commands available for Duke. |
| Special Instructions | Highlights some of the possible issues users can face while using Duke. |
| Feedback / Contact | Provide information to contact the creator of Duke |
2. Getting started
2.1 Installation of Duke
To get your very own of Duke, go to my GitHub Duke repository. At that page, click the button clone or download and download the zip file. Once you have downloaded the zip file, extract the file and locate the JAR file for Duke. Assess the JAR file to startup Duke.
2.2 System commands
Here are the commands that are available for Duke.
| Basic Commands | Advance key | Description |
|---|---|---|
| list | l | Shows the current list of task that the user has while using Duke. |
| todo [desc] | t [desc] | To Do task accompanied with the description of the task. |
| deadline [desc] /by [time] | d [desc] /by [time] | Deadline task accompanied with the description of the task and also the time when the task has to be completed. |
| event [desc] /at [time] | e [desc] /at [time] | Event task accompanied with the description of the task and also the time when the task is occurring. |
| find [keyword] | f [keyword] | Given a keyword from the user, Duke will search and show tasks that matches the keyword. |
| done [index] | do [index] | Checks the specified task in the list. |
| delete [index] | dd [index] | Deletes the specified task in the list. |
| help | - | Provides a list of commands that Duke supports for the user. |
| morehelp | - | Links users to a help page for Duke. |
| bye | bb | Save the current list and close Duke. |
3. Special Instruction for Error Correction
3.1 Exception Handling
Here are some of the possible violations that users may encounter when using Duke:
-
Number error exception: The specific index that the user give is not a valid number recognized by Java
-
Index out of bound exception: The specific index that the user give is out of the range of the number of task in the task list.
-
Duke exception: Duke exceptions are thrown when the user gives an invalid command which Duke does not recognize.
Should there be any other issues faced with Duke, feel free to contact the developer instead. Thank you!
3.2 Help page
Should there be any other issues with Duke, feel free to enter the help command to get a list of commands that Duke support. Also, typing morehelp will give a more detailed explanation on how to use Duke.
4. Feedback and Contact us
4.1 Contact us
Thank you for using Duke. Feel free to drop the developer a feedback in order to improve Duke further! I can be connected through the following channels:
4.2 Special thanks
________ ___ ___ ___ __ _______
|\ ___ \|\ \|\ \|\ \|\ \ |\ ___ \
\ \ \_|\ \ \ \\\ \ \ \/ /|\ \ __/|
\ \ \ \\ \ \ \\\ \ \ ___ \ \ \_|/__
\ \ \_\\ \ \ \\\ \ \ \\ \ \ \ \_|\ \
\ \_______\ \_______\ \__\\ \__\ \_______\
\|_______|\|_______|\|__| \|__|\|_______|