Skip to content

Commit 2348e01

Browse files
committed
[Doc] - Add product screenshot and user guide
1 parent 846b497 commit 2348e01

File tree

2 files changed

+140
-6
lines changed

2 files changed

+140
-6
lines changed

docs/README.md

Lines changed: 140 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,153 @@
22

33
## Features
44

5-
### Feature 1
6-
Description of feature.
5+
### Check off your tasks
6+
Duke provides the functionality of a to-do list with 3 built-in task types: Todos, Deadlines and Events.
7+
Once you are done with a task, you can mark it as complete and Duke will remember its completion status.
8+
9+
### Search for related tasks
10+
If your task list is simply too long, Duke allows you to streamline your search for related tasks by keyword.
11+
12+
### Reschedule tasks
13+
A deadline changed, or you made a typo? Fret not! Duke lets you reschedule your tasks with one easy command.
714

815
## Usage
916

10-
### `Keyword` - Describe action
17+
### `Keyword` - todo
18+
19+
Create a Todo task with a given description.
20+
21+
Example of usage:
22+
23+
`todo 2103 IP`
24+
25+
Expected outcome:
26+
27+
`Got it. I've added this task:`
28+
` [T][✘] 2103 IP`
29+
`Now you have x tasks in the list.`
30+
31+
### `Keyword` - deadline
32+
33+
Create a Deadline task with a given description as well as due date.
34+
35+
Example of usage:
36+
37+
`Usage: deadline 2103 IP submission /by 24-02-2020`
38+
39+
Expected outcome:
40+
41+
`Got it. I've added this task:`
42+
` [D][✘] 2103 IP submission (by: Feb 24 2020, 00:00)`
43+
`Now you have 2 tasks in the list.`
44+
45+
### `Keyword` - event
46+
47+
Create an Event task with a given description, start and end time.
48+
49+
Example of usage:
50+
51+
`Usage: event 2103 tutorial /at 19/02/2020 12:00 to 19/02/2020 13:00`
52+
53+
Expected outcome:
54+
55+
`Got it. I've added this task:`
56+
` [E][✘] 2103 tutorial (at: Feb 19 2020, 12:00 to Feb 19 2020, 13:00)`
57+
`Now you have 3 tasks in the list.`
58+
59+
### `Keyword` - done
60+
61+
Mark a task as complete.
62+
63+
Example of usage:
64+
65+
`done 1`
66+
67+
Expected outcome:
68+
69+
`Nice! I've marked this task as done:`
70+
` [T][✓] 2103 IP`
71+
72+
### `Keyword` - done
73+
74+
Mark a task as complete by index.
75+
76+
Example of usage:
77+
78+
`done 1`
79+
80+
Expected outcome:
81+
82+
`Nice! I've marked this task as done:`
83+
` [T][✓] 2103 IP`
84+
85+
### `Keyword` - list
86+
87+
List all tasks.
88+
89+
Example of usage:
90+
91+
`list`
92+
93+
Expected outcome:
94+
95+
`Here are the tasks in your list:`
96+
`1.[T][✓] 2103 IP`
97+
`2.[D][✘] 2103 IP submission (by: Feb 24 2020, 00:00)`
98+
`3.[E][✘] 2103 tutorial (at: Feb 19 2020, 12:00 to Feb 19 2020, 13:00)`
1199

12-
Describe action and its outcome.
100+
### `Keyword` - delete
101+
102+
Delete a task by index.
103+
104+
Example of usage:
105+
106+
`delete 3`
107+
108+
Expected outcome:
109+
110+
`Noted. I've removed this task:`
111+
` [E][✘] 2103 tutorial (at: Feb 19 2020, 12:00 to Feb 19 2020, 13:00)`
112+
`Now you have 2 tasks in the list.`
113+
114+
### `Keyword` - find
115+
116+
Search for related tasks by keyword.
13117

14118
Example of usage:
15119

16-
`keyword (optional arguments)`
120+
`find submission`
17121

18122
Expected outcome:
19123

20-
`outcome`
124+
`Here are the matching tasks in your list:`
125+
`1.[D][✘] 2103 IP submission (by: Feb 24 2020, 00:00)`
126+
127+
### `Keyword` - reschedule
128+
129+
Reschedule a task by index (Deadline or Event).
130+
131+
Example of usage:
132+
133+
`reschedule 2 25/12/2020`
134+
135+
Expected outcome:
136+
137+
`I've rescheduled this task:`
138+
` [D][✘] 2103 IP submission (by: Dec 25 2020, 00:00)`
139+
140+
### `Keyword` - bye
141+
142+
Exit Duke.
143+
144+
Example of usage:
145+
146+
`bye`
147+
148+
Expected outcome:
149+
150+
`Save Success! See you next time!`
151+
152+
153+
154+

docs/Ui.png

145 KB
Loading

0 commit comments

Comments
 (0)