From 117aec7f1edc1d606cafbe1953e11402a2c60463 Mon Sep 17 00:00:00 2001 From: Gavzzz <91276149+Gavzzz@users.noreply.github.com> Date: Tue, 20 Sep 2022 09:44:27 +0800 Subject: [PATCH 1/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d9da4a0a4d..c47f67022f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ DukeProMax allows you to store your daily tasks so you can always give your 100% - USER Friendly - SUPER Fast to use -# SUS for short +# SUS for short :+1: It is absolutely From 76c94ea681ef9baf6129c51452b13ee3bf709596 Mon Sep 17 00:00:00 2001 From: Gavzzz <91276149+Gavzzz@users.noreply.github.com> Date: Wed, 21 Sep 2022 13:30:28 +0800 Subject: [PATCH 2/3] Update README.md --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c47f67022f..6b3a03bfa2 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,22 @@ DukeProMax allows you to store your daily tasks so you can always give your 100% # SUS for short :+1: +1. Download it from [here](https://github.com/Gavzzz/ip) +2. Double-click it. +3. Chat with it to add you tasks +4. Let it manage your tasks for you -It is absolutely + +The best part? It is absolutely # FREE!! Features include but not limited to -1. Managing tasks -2. Managing events -3. Finding tasks +- [x] Managing tasks +- [x] Managing events +- [x] Finding tasks +- [ ] More extensions coming soon So what are you waiting for??? From 4187f78a1ed3a17d43216259f782de8767a096f8 Mon Sep 17 00:00:00 2001 From: Gavzzz <91276149+Gavzzz@users.noreply.github.com> Date: Wed, 21 Sep 2022 18:39:04 +0800 Subject: [PATCH 3/3] Update README.md --- docs/README.md | 126 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 116 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8077118ebe..5434151d5f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,29 +1,135 @@ -# User Guide +# User Guide for DukeMaxPro ## Features -### Feature-ABC +### Add Tasks -Description of the feature. +Add up to 3 different types of tasks! -### Feature-XYZ +[todo] + +A todo task denoted by [T] + +input format: "todo" + task description + +[deadline] + +A deadline task denoted by [D] + +A deadline task with a deadline to be input, denoted by [D] + +Input format: "deadline" + task description + "/by" + deadline + +[Event] + +An event task with a time of event, denoted by [E] + +Input format: "event" + task description + "/at" + time of event + +### Mark / Unmark tasks as done + +Marks tasks as done with an "X" or undone without an "X" and with an empty box [ ] +to keep track of task completion. + +### View task list + +Displays the entire task list + +### Detect duplicates + +Detects duplicate tasks inside the task lists and alerts the user about which +task is duplicated and how many tasks are duplicated -Description of the feature. ## Usage -### `Keyword` - Describe action +### `list` - Displays current task list + + +Example of usage: + +`list` + +Expected outcome: + +``` +[T][X] Borrow book +[D][ ] Return Book (by: Monday 2pm) +[E][ ] Meeting (at: Monday 2pm-4pm) +``` + +### `todo` - Adds a todo task to the task list -Describe the action and its outcome. Example of usage: -`keyword (optional arguments)` +`todo` + Expected outcome: -Description of the outcome. +``` +[T][X] Borrow book +``` + +### `deadline` - Adds a deadline task to the task list + + +Example of usage: + +`deadline` + + +Expected outcome: ``` -expected output +[D][ ] Return Book (by: Monday 2pm) ``` + +### `event` - Adds a event task to the task list + + +Example of usage: + +`event` + + +Expected outcome: + +``` +[E][ ] Meeting (at: Monday 2pm-4pm) +``` + +### `mark` - Marks a task as done in the task list + + +Example of usage: + +`mark 1` + + +Expected outcome: + +``` +[E][X] Meeting (at: Monday 2pm-4pm) +``` + +### `unmark` - Unarks a task as not done in the task list + + +Example of usage: + +`unmark 1` + + +Expected outcome: + +``` +[E][ ] Meeting (at: Monday 2pm-4pm) +``` + + + + + +