forked from nus-cs2103-AY2324S1/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
12bcedd
commit 49f899d
Showing
1 changed file
with
36 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,29 +1,51 @@ | ||
# User Guide | ||
# ChatterBox User Guide | ||
|
||
## Features | ||
ChatterBox is your friendly neighbourhood task manager! Never forget anything ever again! | ||
|
||
### Feature-ABC | ||
## Features | ||
ChatterBox comes with a bunch of features such as: | ||
- Managing tasks | ||
- Todos, Events, Deadlines | ||
- Mark and Unmark tasks | ||
- Delete a single task | ||
- Find a task | ||
- Save tasks locally | ||
- Mass delete all tasks (and start afresh!) | ||
|
||
Description of the feature. | ||
### Functionality | ||
|
||
### Feature-XYZ | ||
ChatterBox's primary interaction method is the keyboard, so you can keep working without having to lift your palms! The currently available primary commands include: | ||
- todo <task> | ||
- event /from <start> /to <end> | ||
- deadline /by <date> | ||
|
||
Description of the feature. | ||
Other commands include: | ||
- list | ||
- find <keyword> | ||
- delete <index> | ||
- mark <index> | ||
- unmark <index> | ||
|
||
## Usage | ||
And when you wanna start over, there's always: | ||
|
||
### `Keyword` - Describe action | ||
- delete_all | ||
|
||
Describe the action and its outcome. | ||
Once you're done with ChatterBox, simply enter: | ||
|
||
Example of usage: | ||
- bye | ||
|
||
`keyword (optional arguments)` | ||
## Usage | ||
|
||
Expected outcome: | ||
You can download the latest release from [here](https://github.com/sp4ce-cowboy/ip/releases/tag/A-Release) and then: | ||
|
||
Description of the outcome. | ||
1. Navigate into the directory with | ||
|
||
```sh | ||
cd <PATH> | ||
``` | ||
expected output | ||
|
||
2. Run Chatterbox | ||
|
||
```sh | ||
java -jar duke.jar | ||
``` |