forked from nus-cs2103-AY2223S2/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
1 parent
413eb25
commit 3b61fdd
Showing
2 changed files
with
91 additions
and
15 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,29 +1,105 @@ | ||
| # User Guide | ||
| # User Guide for DUKE | ||
|
|
||
| ##Overview | ||
| Duke is a task management chatbot that allows you to keep track | ||
| of your tasks and manage them. You can ask Duke to create new tasks | ||
| and tick them off when done. You can also edit, delete, and find your | ||
| tasks as you wish. Both GUI and command line interface are present in DUKE | ||
|
|
||
| ## Features | ||
|
|
||
| ### Feature-ABC | ||
| ### 1. `todo` | ||
|
|
||
| Add a todo to your tasks list. | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > todo [description] | ||
| > | ||
| > todo read book | ||
|
|
||
| ### 2. `deadline` | ||
|
|
||
| Add a deadline to your tasks list. Specify date in YYYY-MM-DD HHMM (24HR time) | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > deadline [description] /by [YYYY-MM-DD HHMM] | ||
| > | ||
| > deadline Assignment /by 2023-02-10 1800 | ||
| ### 3. `event` | ||
|
|
||
| Add an event to your tasks list. Specify start and end date in YYYY-MM-DD HHMM (24HR time) | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > event [description] /from [YYYY-MM-DD HHMM] /to [YYYY-MM-DD HHMM] | ||
| > | ||
| > event project meeting /from 2023-02-10 1800 /to 2023-02-11-1800 | ||
| ### 4. `list` | ||
|
|
||
| Print out the tasks in DUKE | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > list | ||
| ### 5. `mark` | ||
|
|
||
| Mark the task as done | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > mark [index number starting from 1] | ||
| > | ||
| > mark 2 | ||
| Description of the feature. | ||
|
|
||
| ### Feature-XYZ | ||
| ### 6. `unmark` | ||
|
|
||
| Description of the feature. | ||
| Mark the task as not done | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > unmark [index number starting from 1] | ||
| > | ||
| > unmark 2 | ||
| ## Usage | ||
|
|
||
| ### `Keyword` - Describe action | ||
| ### 7. `delete` | ||
|
|
||
| Describe the action and its outcome. | ||
| Deletes a specified task in DUKE | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > delete [index number starting from 1] | ||
| > | ||
| > delete 2 | ||
| Example of usage: | ||
| ### 8. `find` | ||
|
|
||
| `keyword (optional arguments)` | ||
| Find a task with the same keyword | ||
| >Use GUI for faster access. | ||
| > | ||
| > Alternatively, command line: | ||
| > | ||
| > find [keyword] | ||
| > | ||
| > find read book | ||
| Expected outcome: | ||
| ### 9. `bye` | ||
|
|
||
| Description of the outcome. | ||
| Say goodbye to DUKE | ||
| >Command line only: | ||
| > | ||
| > bye | ||
| ``` | ||
| expected output | ||
| ``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.