forked from nus-cs2113-AY2021S2/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
2e2b12d
commit f94e095
Showing
2 changed files
with
30 additions
and
7 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,20 +1,45 @@ | ||
# User Guide | ||
A brief User Guide for CS2113T IP Project | ||
|
||
## Features | ||
|
||
### Feature 1 | ||
Description of feature. | ||
Adds a todo to the list. | ||
|
||
### Feature 2 | ||
Adds a deadline to the list. | ||
|
||
### Feature 3 | ||
Adds an event to the list. | ||
|
||
### Feature 4 | ||
Marks a task as completed on the list. | ||
|
||
### Feature 5 | ||
Deletes a task from the list. | ||
|
||
### Feature 6 | ||
Finds an item on the list. | ||
|
||
### Feature 7 | ||
Views the current list. | ||
|
||
|
||
## Usage | ||
|
||
### `Keyword` - Describe action | ||
### `todo task` - adds a task to the list | ||
|
||
Describe action and its outcome. | ||
Adds a tasks that is categorized as todo to the list. | ||
|
||
Example of usage: | ||
|
||
`keyword (optional arguments)` | ||
`todo read book` | ||
|
||
Expected outcome: | ||
|
||
`outcome` | ||
―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― | ||
Got it. I've added this task: | ||
[T] [ ] read book | ||
Now you have 1 tasks in the list. | ||
|
||
―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― |
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,2 +0,0 @@ | ||
[T] [X] read book | ||
[D] [X] return book (by: June 6th) | ||