Skip to content

Commit

Permalink
Added User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kangzongxian committed Sep 13, 2022
1 parent 843c33b commit 589e3a0
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 15 deletions.
119 changes: 106 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,122 @@
# User Guide
# User Guide for Duke

Welcome to Dukity-Duke! This bot will help you manage your
tasks so that you can stay on track towards your goals!

## Features

### Feature-ABC
### Create a Todo

This feature creates a Todo Task.

Description of the feature.
```
input: todo return book
expected output:
Got it. I've added this task:
[T][] return book
```


### Create an Event

This feature creates an Event Task.
```
input: event project meeting /at Mon 2-4pm
### Feature-XYZ
expected output:
Got it. I've added this task:
[E][] project meeting(at:Mon 2-4pm)
```

Description of the feature.
### Create a Deadline

## Usage
This feature creates a Deadline Task.
```
input: deadline return book /by 2/12/2019 1800
### `Keyword` - Describe action
expected output:
Got it. I've added this task:
[D][] return book (by: 2019-12-02 1800)
```

Describe the action and its outcome.
### Mark a Task as Done
This feature marks a task as done.
```
Assuming is the task is the first 1, and is called
todo return book
Example of usage:
input: mark 1
`keyword (optional arguments)`
expected output:
Nice! I've marked this task as done:
[T][X] return book
```

Expected outcome:
### Mark a Task a not Done
This feature removes a mark on a task that was marked done.
```
Assuming is the marked task is the first 1, and is called
todo return book
Description of the outcome.
input: unmark 1
expected output:
OK, I've marked this task as not done yet:
[T][] return book
```
expected output

### List all Tasks
This feature lists all the tasks and their status.
```
Assuming we have 2 tasks, one is called todo return book,
the other is called event project meeting /at Mon 2-4pm
input: list
expected output:
Here are the tasks in your list:
1.[T][] return book
2.[E][] project meeting (at:Mon 2-4pm)
```
### Delete a Task
This feature deletes a task from the list.
```
Assuming is the task is the first 1, and is called
todo return book
input: delete 1
expected output:
Noted. I've removed this task:
[T][] return book
```



[//]: # (## Usage)

[//]: # ()
[//]: # (### `Keyword` - Describe action)

[//]: # ()
[//]: # (Describe the action and its outcome.)

[//]: # ()
[//]: # (Example of usage: )

[//]: # ()
[//]: # (`keyword (optional arguments)`)

[//]: # ()
[//]: # (Expected outcome:)

[//]: # ()
[//]: # (Description of the outcome.)

[//]: # ()
[//]: # (```)

[//]: # (expected output)

[//]: # (```)
3 changes: 1 addition & 2 deletions src/main/duke.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
[T][X] return book
[E][] project meeting (at: Mon 2-4pm)
[D][] return book (by: 2019-12-02 2/12/2019 1800)
[T][] buy computing books

0 comments on commit 589e3a0

Please sign in to comment.