forked from nus-cs2113-AY2425S1/ip
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
154 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,160 @@ | ||
# Duke User Guide | ||
# TheThinker User Guide | ||
|
||
// Update the title above to match the actual product name | ||
|
||
// Product screenshot goes here | ||
![img.png](img.png) | ||
|
||
// Product intro goes here | ||
TheThinker is a task manager which allows you to add different task. | ||
Task includes Deadlines , Events and Todo | ||
|
||
## Adding deadlines | ||
|
||
// Describe the action and its outcome. | ||
Add task which has a specific deadline. | ||
|
||
// Give examples of usage | ||
Example: `deadline return book /by 20/10/2025 1800` | ||
|
||
Example: `keyword (optional arguments)` | ||
``` | ||
____________________________________________________________ | ||
Got it. I've added this task: | ||
[D][ ] return book (by: 20 October 2025 , 6 pm) | ||
Now you have 1 tasks in the list. | ||
____________________________________________________________ | ||
``` | ||
|
||
## Add Event | ||
|
||
Add task which has a duration. | ||
|
||
Example: `event travel /from 20/10/2025 1800 /to 20/11/2025 1800` | ||
|
||
``` | ||
____________________________________________________________ | ||
Got it. I've added this task: | ||
[E][ ] travel (from: 20 October 2025 , 6 pm to: 20 November 2025 , 6 pm) | ||
Now you have 2 tasks in the list. | ||
____________________________________________________________ | ||
``` | ||
|
||
|
||
## Add todo | ||
|
||
// A description of the expected outcome goes here | ||
Add task without deadlines. | ||
|
||
Example: `todo travel` | ||
|
||
``` | ||
____________________________________________________________ | ||
Got it. I've added this task: | ||
[T][ ] travel | ||
Now you have 3 tasks in the list. | ||
____________________________________________________________ | ||
``` | ||
|
||
## Mark and Unmark Task | ||
|
||
Mark task as complete and incomplete. | ||
|
||
Example: `mark 1` | ||
|
||
``` | ||
expected output | ||
____________________________________________________________ | ||
Here are the tasks in your list: | ||
1. [D][ ] return book (by: 20 October 2025 , 6 pm) | ||
2. [E][ ] travel (from: 20 October 2025 , 6 pm to: 20 November 2025 , 6 pm) | ||
3. [T][ ] travel | ||
____________________________________________________________ | ||
____________________________________________________________ | ||
Nice! I've marked this task as done: | ||
[D][X] return book | ||
____________________________________________________________ | ||
``` | ||
Example: `Mark 1` | ||
|
||
## Feature ABC | ||
``` | ||
____________________________________________________________ | ||
OK, I've marked this task as not done yet: | ||
[D][ ] return book | ||
____________________________________________________________ | ||
``` | ||
|
||
// Feature details | ||
## Help | ||
|
||
Prints the format for all the commands available | ||
|
||
## Feature XYZ | ||
Example: `help` | ||
|
||
// Feature details | ||
``` | ||
____________________________________________________________ | ||
Formats for the commands are : | ||
mark : mark [number] | ||
unmark : unmark [number] | ||
delete : delete [number] | ||
todo : todo [task] | ||
event : event [task] /from [start time] /by [end time] | ||
deadline : deadline [task] /by [time] | ||
get : get [dd/mm/yyyy] | ||
find : find [keyword] | ||
____________________________________________________________ | ||
``` | ||
|
||
## Delete | ||
|
||
Delete a specific task from the list | ||
|
||
Example: `delete 1` | ||
|
||
``` | ||
____________________________________________________________ | ||
Here are the tasks in your list: | ||
1. [D][ ] return book (by: 20 October 2025 , 6 pm) | ||
2. [E][ ] travel (from: 20 October 2025 , 6 pm to: 20 November 2025 , 6 pm) | ||
3. [T][ ] travel | ||
____________________________________________________________ | ||
____________________________________________________________ | ||
Noted. I've removed this task: | ||
[D][ ] return book (by: 20 October 2025 , 6 pm) | ||
Now you have 2 tasks in the list. | ||
____________________________________________________________ | ||
``` | ||
|
||
|
||
## Get | ||
|
||
Get all the task which are of specific date | ||
|
||
Example: `get 20/10/2025` | ||
|
||
``` | ||
____________________________________________________________ | ||
Here are the tasks in your list: | ||
1. [E][ ] travel (from: 20 October 2025 , 6 pm to: 20 November 2025 , 6 pm) | ||
2. [T][ ] travel | ||
3. [T][ ] return book | ||
____________________________________________________________ | ||
get 20/10/2025 | ||
____________________________________________________________ | ||
Here are the tasks in your list in 20/10/2025 : | ||
1. [E][ ] travel (from: 20 October 2025 , 6 pm to: 20 November 2025 , 6 pm) | ||
____________________________________________________________ | ||
``` | ||
|
||
## Find | ||
|
||
Get all the task which are of specific keyword | ||
|
||
Example: `find travel` | ||
|
||
``` | ||
____________________________________________________________ | ||
Here are the tasks in your list: | ||
1. [E][ ] travel (from: 20 October 2025 , 6 pm to: 20 November 2025 , 6 pm) | ||
2. [T][ ] travel | ||
3. [T][ ] return book | ||
____________________________________________________________ | ||
find travel | ||
____________________________________________________________ | ||
Here are the matching tasks in your list: | ||
1. [E][ ] travel (from: 20 October 2025 , 6 pm to: 20 November 2025 , 6 pm) | ||
2. [T][ ] travel | ||
____________________________________________________________ | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,3 @@ | ||
E | false | travel | 20 October 2025 , 6 pm | 20 November 2025 , 6 pm | ||
T | false | travel | ||
T | false | return book | ||
T | false | get book | ||
T | false | get book | ||
T | false | return book | ||
T | false | return book | ||
D | false | add task | 20 October 2019 , 6 pm | ||
E | false | add task | 20 October 2019 , 6 pm | 20 October 2019 , 8 pm | ||
D | false | create | 20/10/2019 | ||
D | false | create | 20 October 2019 , 3 pm | ||
D | false | create | 20/10/2019 | ||
D | false | create | 20/10/2019 6 pm | ||
E | false | create | 20 October 2019 , 4 pm | 20 October 2019 , 7 pm | ||
E | false | create | 20 October 2019 , 4 pm | 20/10/2019 | ||
E | false | create | 20/10/2019 | 20 October 2019 , 7 pm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters