Skip to content

Commit 2a7cedf

Browse files
committed
Update user guide
1 parent 489d546 commit 2a7cedf

1 file changed

Lines changed: 158 additions & 6 deletions

File tree

docs/README.md

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

33
## Features
44

5-
### Feature 1
6-
Description of feature.
5+
### Add tasks
6+
You can add a task to the task list.
7+
Duke recognises 3 types of tasks.
8+
* `Todo` - A task with no time requirement
9+
* `Deadline` - A task with a deadline
10+
* `Event` - A task with a specified time
11+
12+
### List tasks
13+
You can display the task list. Tasks will be shown
14+
in the order they were added.
15+
16+
### Mark tasks as done
17+
You can mark a task as done. Note that done tasks will
18+
not be automatically deleted. Additionally, you will
19+
not be able to undo this action.
20+
21+
### Delete task
22+
You can delete a task from the task list.
23+
24+
### Find task
25+
You can search for a task containing a given keyword.
26+
27+
### Exit
28+
You can exit the program.
29+
30+
### Auto save
31+
The task list will be automatically saved after every change
32+
and will persist through subsequent sessions.
733

834
## Usage
935

10-
### `Keyword` - Describe action
36+
### `todo` - Add a Todo task
1137

12-
Describe action and its outcome.
38+
Adds a task with name as provided.
1339

1440
Example of usage:
1541

16-
`keyword (optional arguments)`
42+
`todo (name)`\
43+
`t (name)`
44+
45+
Expected outcome:
46+
47+
`Task added:`\
48+
`[T][ ] (name)`\
49+
`Total tasks in list: (number of tasks)`
50+
51+
### `deadline` - Add a Deadline task
52+
53+
Adds a task with name and date as provided.
54+
The date should be in `yyyy-MM-dd` format.
55+
56+
Example of usage:
57+
58+
`deadline (name) /by (date)`\
59+
`d (name) /by (date)`
60+
61+
Expected outcome:
62+
63+
`Task added:`\
64+
`[D][ ] (name) (by: (date))`\
65+
`Total tasks in list: (number of tasks)`
66+
67+
### `event` - Add an Event task
68+
69+
Adds a task with name and date as provided.
70+
The date should be in `yyyy-MM-dd` format.
71+
72+
Example of usage:
73+
74+
`event (name) /at (date)`\
75+
`e (name) /at (date)`
76+
77+
Expected outcome:
78+
79+
`Task added:`\
80+
`[E][ ] (name) (at: (date))`\
81+
`Total tasks in list: (number of tasks)`
82+
83+
### `list` - Show the task list
84+
85+
Shows the saved list of tasks.
86+
87+
Example of usage:
88+
89+
`list`\
90+
`l`
91+
92+
Expected outcome:
93+
94+
`Tasks in list:`\
95+
`1.(task details)`\
96+
`...`
97+
98+
### `done` - Mark a task as done
99+
100+
Marks as done the task at the provided numerical index of the list.
101+
This number corresponds to the one shown by `list`.
102+
103+
Example of usage:
104+
105+
`done (index)`\
106+
`do (index)`
107+
108+
Expected outcome:
109+
110+
`Successfully marked as done:`\
111+
`[(task type)][X] (task description)`
112+
113+
### `delete` - Delete a task
114+
115+
Deletes the task at the provided numerical index of the list.
116+
This number corresponds to the one shown by `list`.
117+
118+
Example of usage:
119+
120+
`delete (index)`\
121+
`del (index)`
122+
123+
Expected outcome:
124+
125+
`Successfully removed:`\
126+
`(task details)`\
127+
`Total tasks in list: (number of tasks)`
128+
129+
### `find` - Find a task
130+
131+
Searches for all tasks containing the provided keyword.
132+
This will only consider the first provided keyword.
133+
134+
Example of usage:
135+
136+
`find (keyword)`\
137+
`f (keyword)`
138+
139+
Expected outcome:
140+
141+
`Matching tasks in list:`\
142+
`1.(task details)`\
143+
`...`
144+
145+
### `delete` - Delete a task
146+
147+
Deletes the task at the provided numerical index of the list.
148+
This number corresponds to the one shown by `list`.
149+
150+
Example of usage:
151+
152+
`delete (index)`\
153+
`del (index)`
154+
155+
Expected outcome:
156+
157+
`Successfully removed:`\
158+
`(task details)`\
159+
`Total tasks in list: (number of tasks)`
160+
161+
### `bye` - Exit the program
162+
163+
Closes the program immediately.
164+
165+
Example of usage:
166+
167+
`bye`\
168+
`b`
17169

18170
Expected outcome:
19171

20-
`outcome`
172+
>The program closes.

0 commit comments

Comments
 (0)