Skip to content

Commit fc348d3

Browse files
committed
A-UserGuide: Add feature summary to user guide.
1 parent 4e0952e commit fc348d3

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

docs/README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# User Guide for Duke
2-
Duke is a simple application that makes use of a Command Line Interface to help you in keeping track of your daily tasks.
2+
Duke is a simple application that makes use of a Command Line Interface to help you in managing and keeping track of
3+
your daily tasks.
34

45
## Installation
56
1. Install Java 11 on your machine if you have not done so yet. You can follow the guide [here](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/what-is-corretto-11.html).
@@ -9,6 +10,29 @@ Duke is a simple application that makes use of a Command Line Interface to help
910
5. Run the command `java -jar [filename].jar` to launch the application.
1011

1112
## Features
13+
### 3 Types of Tasks
14+
Duke categorizes tasks into 3 different types: Todo, Deadline and Event.
15+
16+
#### Todo
17+
A Todo is a type of task that does not have any date attached to it and only contains the description.
18+
19+
#### Deadline
20+
A Deadline is a type of task that has to be done by a specified date and time. It contains the description and the date
21+
and time of due.
22+
23+
#### Event
24+
An Event is a type of task that is to be done at a specified date and time. It contains the description and the date and
25+
time of the Event.
26+
27+
### User Friendly Prompts
28+
Duke prompts you with helpful messages to guide you in using the commands correctly whenever an incorrect or invalid
29+
command is given.
30+
31+
### Easy organizing of Tasks
32+
Duke has several features that help in organizing your tasks such as Listing out all tasks, Marking Tasks as Done,
33+
Searching for Tasks by Keyword and Listing out Upcoming Tasks.
34+
35+
## Usage
1236
Note: The parameters for date are to be in `yyyy-MM-dd HH:mm` format. The index of tasks is such that "1" represents the
1337
first task in the list.
1438

0 commit comments

Comments
 (0)