diff --git a/DATA/duke.txt b/DATA/duke.txt index 754289e590..e69de29bb2 100644 --- a/DATA/duke.txt +++ b/DATA/duke.txt @@ -1,13 +0,0 @@ -[T][] 1 -[T][X] 2 -[T][] 3 -[T][] test -[D][] project 1 (by: Aug 20 2022) -[T][] testing 1 -[T][] 1 -[D][X] 2 (by: 20-08-2002) -[T][] 3 -[D][] ss (by: Jul 20 2022) -[E][X] aa (at: 2-4pm) -[T][] 1 -[T][X] 2 diff --git a/docs/README.md b/docs/README.md index 8077118ebe..1d34ca2220 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,29 +1,153 @@ -# User Guide - +# User Guide To Duke +Duke is an app for managing and organising tasks. It is fun and easy to use! Download and use it now! ## Features -### Feature-ABC +### Add tasks +Adds todo, event, deadline tasks to a task list +### Delete tasks +Deletes tasks from a tasklist +### Mark tasks +Marks a task as done +### Unmark tasks +Unmarks a task as undone +### Find tasks +Finds a task which includes the keyword written +### List tasks +Displays tasks that are stored in the task list + -Description of the feature. -### Feature-XYZ -Description of the feature. +## Guide on the usage of different commands -## Usage +### `Todo` +Adds a Todo task to the task list. -### `Keyword` - Describe action +**Example of usage:** -Describe the action and its outcome. +`todo homework` -Example of usage: +**Expected output**: -`keyword (optional arguments)` +``` +Got it. I've added the task: +[T][] homework +Now you have 1 task in the list +``` +### `Deadline` +Adds a Todo task to the task list. -Expected outcome: +**Example of usage:** -Description of the outcome. +`deadline assignment /by 2022-09-20` +**Expected output:** ``` -expected output +Got it. I've added the task: +[D][] assignment (by Sep 20 2022) +Now you have 2 task in the list. +``` +### `Event` +Adds a Todo task to the task list. + +**Example of usage:** + +`event meeting /at 3-5pm` + +**Expected output**: + +``` +Got it. I've added the task: +[E][] meeting (at 3-5pm) +Now you have 3 task in the list +``` +### `Delete ` +Deletes a task to the task list. + +**Example of usage:** + +`delete 1` + + +**Expected output**: + +``` +Noted. I've removed this task: +[T][] homework +Now you have 2 tasks in the list. +``` + +### `Mark ` +Marks a completed task as done. + +**Example of usage:** + +`mark 2` + + +**Expected output**: + +``` +Nice! I've marked this task as done: +[D][X] assignment (by Sep 20 2022) +``` + +### `Mark ` +Unmarks a task as done. + +**Example of usage:** + +`unmark 1` + + +**Expected output**: + +``` +Ok. I've marked this task as not done yet: +[D][] assignment (by Sep 20 2022) +``` + + +### `Find ` +Finds tasks that contains the keyword inputted by user +and outputs all such tasks to the user. + +**Example of usage:** + +`find assingment` + + +**Expected output**: + +``` +1. [D][] assignment (by Sep 20 2022) +``` + +### `List ` +Display tasks that are stored in the task list. + +**Example of usage:** + +`list` + + +**Expected output**: + +``` +1. [D][] assignment (by Sep 20 2022) +2. [E][] meeting (at 3-5pm) +``` + + +### `Bye ` +Exit the program. + +**Example of usage:** + +`bye` + + +**Expected output**: ``` +Bye. Hope to see you again soon! +``` \ No newline at end of file diff --git a/docs/Ui.png b/docs/Ui.png new file mode 100644 index 0000000000..df836f5516 Binary files /dev/null and b/docs/Ui.png differ