View on GitHub

ip

User Guide

Duke (Also known as Dwayne The Rock Johnson) is your friendly productivity assistant chatbot. Simply type into the message box and send your inputs and Duke’s got your back!


Quick Start

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest duke.jar from here

  3. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Take note this image reflects the state of the GUI after adding some sample commands so yours may look empty initially.

  4. Type the command in the message box and press Enter to execute it. e.g. typing list and pressing Enter will give you a list of tasks. Some example commands you can try:


Features

:information_source: Notes about the command format:

  • Fields after deadline/event descriptions should be followed by a / and a preposition such as by or at with no whitespace in between. The subsequent field takes in a date in the YYYY-MM-DD format with a whitespace before the field. Any other date format is not able to be accepted.
    e.g. deadline Homework /by 2020-08-08 creates a deadline for homework at 2020-08-28, but using 2020-28-08 will not be accepted.

  • The commands done and delete need to be followed by a whitespace and an integer greater than 0 and less than or equals to the size of the task list.
    e.g done 1 will mark the first task as done, delete 1 will mark the first task as deleted from the list but done 0 or delete will both neither be accepted inputs.

  • The task-identifying commands todo, deadline and event must have text input after these fields.
    e.g. todo Read a book is an accepted input, but todo is not

  • The input and commands are case sensitive.
    e.g. todo Read a book is an accepted input, but Todo read a book is not

Adding a todo: todo

Adds a todo task to the task list.

Format: todo TASK_DESCRIPTION

Examples:

Adding a deadline: deadline

Adds a deadline to the task list.

Format: deadline TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD

Examples:

Adding an event: event

Adds an event to the task list.

Format: event TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD

Examples:

Listing all tasks : list

Shows a list of all persons in the task list, sorted by todos at the top and by dates of deadlines/events in chronological order (from soonest to latest).
Each list element has a marker [T], [E] or [D] to indicate whether the task is of type todo, event or deadline respectively.
Each list element will show a tick symbol [✔] if the task is marked done, or a cross [x] if undone.

Format: list

Locating task by keywords: find

Finds tasks whose descriptions contain any of the given keywords.

Format: find KEYWORD [MORE_KEYWORDS]

Examples:

Deleting a person : delete

Deletes the specified task from the task list.

Format: delete INDEX

Examples:

Marking a task as done : done

Marks a task as done and changes done symbol ([✔] or [x]) of the specified task on the task list.

Format: done INDEX

Examples:

Exiting the program : bye

Exits the program.

Format: bye


Action Format, Examples
todo todo TASK_DESCRIPTION
e.g., todo Read book
event event TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD
e.g., event Science conference /at 2020-08-08
deadline deadline TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD
e.g., deadline Return books /by 2020-05-07
list list
delete delete INDEX
e.g., delete 3
done edit INDEX
e.g.,done 2
find find KEYWORD [MORE_KEYWORDS]
e.g., find Return books
bye bye