forked from nus-cs2103-AY2324S2/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
8d2f840
commit 7830a65
Showing
2 changed files
with
68 additions
and
14 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,81 @@ | ||
# Duke User Guide | ||
# The TalkingBox User Guide | ||
|
||
// Update the title above to match the actual product name | ||
The TalkingBox is a chatbot app that helps users keep track of their tasks and other notes. | ||
|
||
// Product screenshot goes here | ||
## Features | ||
|
||
// Product intro goes here | ||
### Adding, removing and listing tasks | ||
|
||
## Adding deadlines | ||
You can add 3 types of tasks to the TalkingBox: Todos, Deadlines and Events | ||
|
||
// Describe the action and its outcome. | ||
Example: | ||
|
||
// Give examples of usage | ||
`todo read book` | ||
|
||
Example: `keyword (optional arguments)` | ||
`deadline return book /by 24/3/2024 1600` | ||
|
||
// A description of the expected outcome goes here | ||
The app will then add your tasks to your task list | ||
``` | ||
Added new task: | ||
[T] [] read book | ||
current number of tasks: 1 | ||
``` | ||
|
||
Unwanted tasks can be deleted using the `delete` command | ||
|
||
|
||
You can also view the entire task list with the `list` command | ||
|
||
``` | ||
Current list of tasks: | ||
1. [T] [ ] read book | ||
``` | ||
|
||
### Completing tasks | ||
|
||
You can mark a task number as done using the `mark` command | ||
|
||
``` | ||
mark 1 | ||
Task marked as done. Good job! | ||
1. [T] [x] read book | ||
``` | ||
expected output | ||
|
||
Similarly, you can mark a task as not done using the `unmark` command | ||
|
||
### Finding tasks | ||
|
||
You can search for any tasks containg a certain keyword or key phrase in its name | ||
|
||
``` | ||
find book | ||
Here are the matching tasks in your list: | ||
1. [T] [x] read book | ||
``` | ||
|
||
## Feature ABC | ||
### Adding and viewing notes | ||
|
||
Besides tasks, the program can also be used to store notes using the `write` command | ||
|
||
// Feature details | ||
```dtd | ||
write today was a good day | ||
New note added! | ||
'today was a good day | ||
## Feature XYZ | ||
``` | ||
|
||
the list of notes currently stored can be viewed using the `notes` command | ||
|
||
``` | ||
notes | ||
Current list of notes: | ||
1. today was a good day | ||
``` | ||
|
||
// Feature details | ||
Like tasks, notes can also be removed using the `remove` command |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Manifest-Version: 1.0 | ||
Main-Class: duke.main.Launcher | ||
|