Skip to content

Commit

Permalink
Add screenshot and brief User Guide
Browse files Browse the repository at this point in the history
Duke has no representative screenshot and User Guide for the user to
view.

Let's add these so that the user can go through them and gain a better
understanding of how to use Duke.
  • Loading branch information
weiquu committed Sep 15, 2021
1 parent 46e3068 commit 86b7bc3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,35 @@

## Features

### Feature-ABC
### Task Management

Description of the feature.
Let Duke manage your tasks for you! Simply add a task to your list and update it when completed.

### Feature-XYZ
### Multiple Types of Tasks

Description of the feature.
Want to add details to certain kinds of tasks by adding dates and events? We've 3 different kinds of tasks for you!

### Simple Commands
Duke functions on simple, easy-to-remember commands. Need help? Don't worry! We've a command for that too :grin:

## Usage

### `Keyword` - Describe action
### `list` - Lists all tasks

Describe the action and its outcome.
Lists all tasks and their current status

Example of usage:

`keyword (optional arguments)`
`list`

Expected outcome:

Description of the outcome.
A numbered list of all tasks, e.g.

```
expected output
--------------------------------------------
Here are the tasks in your list:
1. [T][] task_desc
2. [D][X] task_desc (by: 2-5-2022)
--------------------------------------------
```
Binary file added docs/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 86b7bc3

Please sign in to comment.