Skip to content

Commit f3a7531

Browse files
authored
Merge pull request nus-cs2103-AY2021S2#35 from banchiang/update-ug-banchiang
Update user guide remind, help features and command summary
2 parents c66c2e0 + 280d09a commit f3a7531

1 file changed

Lines changed: 38 additions & 8 deletions

File tree

docs/UserGuide.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,16 +93,30 @@ The GUI similar to the below should appear in a few seconds. Note how the app co
9393

9494
</div>
9595

96-
### Viewing help : `help`
96+
### *Viewing help : `help`
9797

98-
Shows a message explaning how to access the help page.
98+
Shows a message explaining how to access the help page.
9999

100100
![help message](images/helpMessage.png)
101101

102102
Format: `help`
103103

104+
### *Turn on/off reminder: `remind`
104105

105-
### Adding an Assignment/Event: `event/deadline`
106+
Turns on and off the reminder system. If remind is on,
107+
a reminder would pop out when starting the app RemindMe regarding
108+
the upcoming tasks.
109+
110+
(insert image of reminder here)
111+
112+
Format: `remind`
113+
114+
Outcome:
115+
116+
* `reminder is turned on!`
117+
* `reminder is turned off!`
118+
119+
### *Adding an Assignment/Event: `event/deadline`
106120

107121
Adds an assignment with a deadline or event to the calendar.
108122

@@ -116,7 +130,7 @@ Examples:
116130
* `event Christmas Party /from 25/12/2021 1800 /to 25/12/2021 2300`
117131
* `deadline CS2103 Assignment /by 03/03/2021 2359`
118132

119-
### Deleting an Assignment/Event: `delete`
133+
### *Deleting an Assignment/Event: `delete`
120134

121135
Deletes an assignment with a deadline or event from the calendar.
122136

@@ -182,7 +196,7 @@ Examples:
182196
* `list` followed by `delete 2` deletes the 2nd person in the address book.
183197
* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
184198

185-
###Viewing Calendar of the current month
199+
### *Viewing Calendar of the current month
186200
Shows an image of the calendar with your reminders (e.g. tasks, assignments datelines, and friends’ birthday) for each specific dates.
187201
![result for 'calendar'](images/calendarResult.png)
188202
Format: `calendar`
@@ -193,11 +207,11 @@ Clears all entries from the address book.
193207

194208
Format: `clear``
195209

196-
### Saving the data
210+
### *Saving the data
197211

198212
RemindMe save your data in the hard disk automatically after every command that changes the data. There is no need for you to save manually.
199213

200-
### Editing the data file
214+
### *Editing the data file
201215

202216
AddressBook data are saved as a JSON file `[JAR file location]/data/remindme.json`. Advanced users are welcome to update data directly by editing that data file.
203217

@@ -215,7 +229,7 @@ Format: `exit
215229
* Examination: Consists of a start time, end time, date which it occurs on and the subject.
216230
* Event: Consists of a start time, end time and the date which it occurs on.
217231

218-
## Command summary
232+
## Command summary (AB3)
219233

220234
Action | Format, Examples
221235
--------|------------------
@@ -227,3 +241,19 @@ Action | Format, Examples
227241
**List** | `list`
228242
**View Calendar** | `calendar`
229243
**Help** | `help`
244+
245+
## Command summary (RemindMe)
246+
247+
Action | Format, Examples
248+
--------|----------------
249+
Add assignment | `(assignment type) (assignment description) (assignment details)`
250+
Delete assignment | `delete (assignment description)`
251+
View assignments | `view A`
252+
View events | `view E`
253+
Turn on/off reminder | `remind`
254+
See commands available | `help`
255+
View calendar | `calendar`
256+
Save data | `save`
257+
Edit data | `edit`
258+
259+

0 commit comments

Comments
 (0)