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
9f0c5c2
commit 76bf603
Showing
2 changed files
with
45 additions
and
30 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,45 @@ | ||
# Duke User Guide | ||
|
||
// Update the title above to match the actual product name | ||
|
||
// Product screenshot goes here | ||
|
||
// Product intro goes here | ||
|
||
## Adding deadlines | ||
|
||
// Describe the action and its outcome. | ||
|
||
// Give examples of usage | ||
|
||
Example: `keyword (optional arguments)` | ||
|
||
// A description of the expected outcome goes here | ||
|
||
``` | ||
expected output | ||
``` | ||
|
||
## Feature ABC | ||
|
||
// Feature details | ||
|
||
|
||
## Feature XYZ | ||
|
||
// Feature details | ||
# Cal User Guide | ||
|
||
## Quick Start | ||
|
||
Description of the feature. | ||
1. Ensure you have Java `11` or above installed in your Computer. | ||
2. Download the latest version of Cal from [here](https://github.com/ValenciaLim/ip/releases/tag/Level-10). | ||
3. Open a command terminal, `cd` into the folder you put the jar file in, and use the following command to run the application. | ||
``` | ||
java -jar cal.jar | ||
``` | ||
4. Refer to the Features[here](#features) below for details of each command. | ||
|
||
## Features | ||
Cal is a chatbot that helps you manage your tasks. It is a simple and easy-to-use chatbot that helps you keep track of your tasks, deadlines and events. | ||
|
||
## Adding events | ||
Adds an event to the task list. | ||
```event <description> /from <datetime> /to <datetime>``` | ||
```deadline <description> /by <datetime>``` | ||
```todo <description>``` | ||
|
||
## Listing all tasks | ||
Lists all tasks in the task list. | ||
```list``` | ||
|
||
## Marking tasks as done | ||
Marks a task as done. | ||
```mark <task number>``` | ||
|
||
## Unmarking tasks as not done | ||
Unmarks a task as not done. | ||
```unmark <task number>``` | ||
|
||
## Deleting tasks | ||
Deletes a task from the task list. | ||
```delete <task number>``` | ||
|
||
## Finding tasks | ||
Finds tasks that match the given keyword. | ||
```find <keyword>``` | ||
|
||
## Exiting the program | ||
Exits the program. | ||
```bye``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.