Skip to content

Commit a9e2735

Browse files
committed
update user guide
1 parent 09b698e commit a9e2735

File tree

1 file changed

+55
-58
lines changed

1 file changed

+55
-58
lines changed

docs/README.md

Lines changed: 55 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,27 @@ I customized it with the theme of my favourite cartoon: Sumikko Gurashi!
1111
![GitHub Logo](Ui.png)
1212

1313
## Features
14-
1. ```help```: provides a list of possible commands
15-
2. ```list```: shows the list of tasks
14+
1. `help`: provides a list of possible commands
15+
2. `list`: shows the list of tasks
1616
3. Add tasks
17-
1. ```todo```: creates a todo task with specific description
18-
2. ```deadline```: creates a deadline task with specific description and date
19-
3. ```event```: creates an event task with specific description and date
20-
4. ```done```: marks a task as complete
21-
5. ```delete```: deletes a task from the list
22-
6. ```clear```: deletes all tasks from the list
23-
7. ```find```: shows task(s) which match the query string
24-
8. ```view```: shows task(s) due on the given date
25-
9. ```bye```: ends the conversation with Shiro
26-
27-
### 1. ```help```
17+
1. `todo`: creates a todo task with specific description
18+
2. `deadline`: creates a deadline task with specific description and date
19+
3. `event`: creates an event task with specific description and date
20+
4. `done`: marks a task as complete
21+
5. `delete`: deletes a task from the list
22+
6. `clear`: deletes all tasks from the list
23+
7. `find`: shows task(s) which match the query string
24+
8. `view`: shows task(s) due on the given date
25+
9. `bye`: ends the conversation with Shiro
26+
27+
### 1. `help`
2828
This command shows a list of all possible commands that Shiro can recognize.
2929

3030
##### Usage
31-
```help```
31+
`help`
3232

3333
##### Example of usage:
34-
```help```
34+
`help`
3535

3636
##### Expected outcome:
3737
```
@@ -48,14 +48,14 @@ available commands are:
4848
10. bye
4949
```
5050

51-
### 2. ```list```
51+
### 2. `list`
5252
This command shows the entire list of tasks.
5353

5454
##### Usage
55-
```list```
55+
`list`
5656

5757
##### Example of usage:
58-
```list```
58+
`list`
5959

6060
##### Expected outcome:
6161
```
@@ -65,14 +65,13 @@ okies! here are the tasks in your list:
6565
3. [E][✘] project meeting (at: Sep 15 2020)
6666
```
6767

68-
### 3.i. ```todo```
68+
### 3.i `todo`
6969
This command adds a *todo* task to the list.
7070

7171
##### Usage
72-
```todo <description>```
72+
`todo <description>`
7373

74-
##### Example of usage:
75-
```todo read book```
74+
##### Example of usage: ``todo read book`
7675

7776
##### Expected outcome:
7877
```
@@ -81,23 +80,23 @@ sure thing! i have added the following task to your list:
8180
you have [1] task(s) in your list
8281
```
8382

84-
### 3.ii. ```deadline```
83+
### 3.ii `deadline`
8584
This command adds a *deadline* task to the list.
8685

8786
##### Usage
88-
```deadline <description> /by <date>```
87+
`deadline <description> /by <date>`
8988

90-
```<date>``` can either be in the format ```<yyyy-mm-dd>``` or ```<day>```.
89+
`<date>` can either be in the format``<yyyy-mm-dd>` or `<day>`.
9190

92-
```<day>``` should only consist the first three letters of the day of week.
91+
`<day>` should only consist the first three letters of the day of week.
9392

94-
For the usage of ```<day>```, the date used will be the next specified day of week in the calendar.
93+
For the usage of``<day>`, the date used will be the next specified day of week in the calendar.
9594
If the day provided is the same as the current day of week,
9695
the date of the next specified day of week in the calendar will also be used,
9796
instead of the current date.
9897

9998
##### Example of usage:
100-
```deadline return book /by 2020-09-20```
99+
`deadline return book /by 2020-09-20`
101100

102101
##### Expected outcome:
103102
```
@@ -106,23 +105,23 @@ sure thing! i have added the following task to your list:
106105
you have [1] task(s) in your list
107106
```
108107

109-
### 3.iii. ```event```
108+
### 3.iii `event`
110109
This command adds an *event* task to the list.
111110

112111
##### Usage
113-
```deadline <description> /by <date>```
112+
`event <description> /by <date>`
114113

115-
```<date>``` can either be in the format ```<yyyy-mm-dd>``` or ```<day>```.
114+
`<date>` can either be in the format `<yyyy-mm-dd>` or `<day>`.
116115

117-
```<day>``` should only consist the first three letters of the day of week.
116+
`<day>` should only consist the first three letters of the day of week.
118117

119-
For the usage of ```<day>```, the date used will be the next specified day of week in the calendar.
118+
For the usage of `<day>`, the date used will be the next specified day of week in the calendar.
120119
If the day provided is the same as the current day of week,
121120
the date of the next specified day of week in the calendar will also be used,
122121
instead of the current date.
123122

124123
##### Example of usage:
125-
```event project meeting /at 2020-09-28```
124+
`event project meeting /at 2020-09-28`
126125

127126
##### Expected outcome:
128127
```
@@ -131,16 +130,16 @@ sure thing! i have added the following task to your list:
131130
you have [1] task(s) in your list
132131
```
133132

134-
### 4. ```done```
133+
### 4. `done`
135134
This command marks the specified task as done.
136135

137136
##### Usage
138-
```done <task_number>```
137+
`done <task_number>`
139138

140139
If the task corresponding with the task number uncompleted [] before, it will now be marked as completed [].
141140

142141
##### Example of usage:
143-
```done 3```
142+
`done 3`
144143

145144
##### Expected outcome:
146145
```
@@ -149,14 +148,14 @@ yay! i have marked this task as done:
149148
you have [1] task(s) in your list
150149
```
151150

152-
### 5. ```delete```
151+
### 5. `delete`
153152
This command deletes the specified task from the list
154153

155154
##### Usage
156-
```delete <task_number>```
155+
`delete <task_number>`
157156

158157
##### Example of usage:
159-
```delete 2```
158+
`delete 2`
160159

161160
##### Expected outcome:
162161
```
@@ -165,28 +164,26 @@ of course! i have deleted this task from your list:
165164
you have [3] task(s) in your list
166165
```
167166

168-
### 6. ```clear```
167+
### 6. `clear`
169168
This command deletes all tasks from the list
170169

171170
##### Usage
172-
```clear```
171+
`clear`
173172

174173
##### Example of usage:
175-
```clear```
174+
`clear`
176175

177176
##### Expected outcome:
178-
```
179-
okie! all the tasks in your list have been cleared :-)
180-
```
177+
`okie! all the tasks in your list have been cleared :-)`
181178

182-
### 7. ```find```
179+
### 7. `find`
183180
This command shows all the tasks which match the query string
184181

185182
##### Usage
186-
```find <keyword(s)>```
183+
`find <keyword(s)>`
187184

188185
##### Example of usage:
189-
```find book```
186+
`find book`
190187

191188
##### Expected outcome:
192189
```
@@ -195,23 +192,23 @@ got it! here are the tasks matching your search:
195192
2. [D][✘] return book (by: Sep 14 2020)
196193
```
197194

198-
### 8. ```view```
195+
### 8. `view`
199196
This command shows all the tasks due on the given date
200197

201198
##### Usage
202-
```view <date>```
199+
`view <date>`
203200

204-
```<date>``` can either be in the format ```<yyyy-mm-dd>``` or ```<day>```.
201+
`<date>` can either be in the format `<yyyy-mm-dd>` or `<day>`.
205202

206-
```<day>``` should only consist the first three letters of the day of week.
203+
`<day>` should only consist the first three letters of the day of week.
207204

208-
For the usage of ```<day>```, the date used will be the next specified day of week in the calendar.
205+
For the usage of `<day>`, the date used will be the next specified day of week in the calendar.
209206
If the day provided is the same as the current day of week,
210207
the date of the next specified day of week in the calendar will also be used,
211208
instead of the current date.
212209

213210
##### Example of usage:
214-
```view 2020-09-20```
211+
`view 2020-09-20`
215212

216213
##### Expected outcome:
217214
```
@@ -220,14 +217,14 @@ got it! here are the tasks on your given date:
220217
2. [D][✘] return book (by: Sep 20 2020)
221218
```
222219

223-
### 8. ```bye```
220+
### 8. `bye`
224221
This command causes the application to exit.
225222

226223
##### Usage
227-
```bye```
224+
`bye`
228225

229226
##### Example of usage:
230-
```bye```
227+
`bye`
231228

232229
##### Expected outcome:
233230
The application closes when this command is sent.

0 commit comments

Comments
 (0)