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
Showing
5 changed files
with
64 additions
and
20 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,71 @@ | ||
# Duke User Guide | ||
# Earl User Guide | ||
|
||
// Update the title above to match the actual product name | ||
Earl is a **desktop chat application to track tasks, optimised for | ||
use via a Command Line Interface (CLI)** while still having the | ||
benefits of a Graphical User Interface (GUI). If you can type fast, | ||
Earl can get your task management done faster than traditional GUI | ||
applications. | ||
|
||
// Product screenshot goes here | ||
 | ||
|
||
// Product intro goes here | ||
## Features | ||
|
||
## Adding deadlines | ||
### Adding ToDos | ||
Adds a todo to the list of tasks. | ||
|
||
// Describe the action and its outcome. | ||
Format: `todo <task name>` | ||
|
||
// Give examples of usage | ||
Example: `todo homework`, `todo wash clothes` | ||
|
||
Example: `keyword (optional arguments)` | ||
*Notes* | ||
+ `<task name>` cannot be empty | ||
|
||
// A description of the expected outcome goes here | ||
### Adding Deadlines | ||
|
||
``` | ||
expected output | ||
``` | ||
Adds a deadline to the list of tasks. | ||
|
||
## Feature ABC | ||
Format: `deadline <task name> /by <date time>` | ||
|
||
// Feature details | ||
Example: `deadline project submission /by 01/01/2024 2359` | ||
|
||
*Notes* | ||
+ `<task name>` cannot be empty. | ||
+ `<date time>` must be of the format `dd/mm/yyyy hhmm` | ||
|
||
## Feature XYZ | ||
### Adding Events | ||
|
||
// Feature details | ||
Adds an event to the list of tasks. | ||
|
||
Format: `event <task name> /from <date time> /to <date time>` | ||
|
||
Example: `event exam /from 01/01/2024 1200 /to 01/01/2024 1400` | ||
|
||
*Notes* | ||
+ `<task name>` cannot be empty. | ||
+ `<date time>` must be of the format `dd/mm/yyyy hhmm` | ||
|
||
### List | ||
|
||
Displays all tasks currently tracked. | ||
|
||
Format: `list` | ||
|
||
### Find | ||
|
||
Displays all tasks with details matching a pattern. | ||
|
||
Format: `find <pattern>` | ||
|
||
Example: `find wash clothes` | ||
|
||
### Mark | ||
|
||
Marks a task as complete. | ||
|
||
Format: `mark <index or range> [<index or range>, ...] ` | ||
|
||
Example: `mark 1 3-5` | ||
|
||
*Notes* | ||
+ Arguments are space separated single indices or ranges | ||
+ Ranges must be of the form `<index>-<index>` |
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
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
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