Skip to content

Commit ab9be28

Browse files
authored
Merge pull request nus-cs2103-AY2021S2#28 from markuz5116/branch-update-ug-markuz5116
Branch update UG markuz5116
2 parents 7ed67fc + 0ebaac2 commit ab9be28

2 files changed

Lines changed: 23 additions & 13 deletions

File tree

docs/UserGuide.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,25 @@ Objectives of RemindMe:
4242
* If you are a Windows user, [here](https://java.tutorials24x7.com/blog/how-to-install-java-11-on-windows) is a tutorial on how to set up Java 11:
4343

4444

45-
4645
2. Download the latest RemindMe.jar from our GitHub release page.
4746
Copy the file to the folder you want to use as the home folder for your RemindMe.
4847
Double click the file to start the app.
4948

5049

5150
3. Alternatively, you can run the command line java -jar RemindMe.jar in your terminal to start the application.
5251
Type the command in the command box and press Enter to execute it.
53-
52+
The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
53+
![Ui](images/Ui.png)
5454

5555
4. Refer to the Features below for details of each command.
5656

57-
57+
* **`deadline`** `description by DD/MM/YYYY TIME`: Adds a task with a deadline.
58+
59+
* **`ordered list`**: Displays an order list of items.
60+
61+
* ** `calendar`**: Dsiplays the calendar with the tasks' deadlines and friends' birthdays.
62+
63+
* **`exit`** : Exits the app.
5864

5965

6066
--------------------------------------------------------------------------------------------------------------------
@@ -163,31 +169,34 @@ Examples:
163169
* `list` followed by `delete 2` deletes the 2nd person in the address book.
164170
* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
165171

172+
###Viewing Calendar of the current month
173+
Shows an image of the calendar with your reminders (e.g. tasks, assignments datelines, and friends’ birthday) for each specific dates.
174+
![result for 'calendar'](images/calendarResult.png)
175+
Format: `calendar`
176+
166177
### Clearing all entries : `clear`
167178

168179
Clears all entries from the address book.
169180

170-
Format: `clear`
171-
172-
### Exiting the program : `exit`
173-
174-
Exits the program.
175-
176-
Format: `exit`
181+
Format: `clear``
177182

178183
### Saving the data
179184

180-
AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
185+
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.
181186

182187
### Editing the data file
183188

184-
AddressBook data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
189+
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.
185190

186191
<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
187-
If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run.
192+
If your changes to the data file makes its format invalid, RemindMe will discard all data and start with an empty data file at the next run.
188193
</div>
189194

195+
### Exiting the program : `exit`
196+
197+
Exits the program.
190198

199+
Format: `exit
191200

192201
## Glossary
193202
* Examination: Consists of a start time, end time, date which it occurs on and the subject.
@@ -203,4 +212,5 @@ Action | Format, Examples
203212
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com`
204213
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
205214
**List** | `list`
215+
**View Calendar** | `calendar`
206216
**Help** | `help`

docs/images/calendarResult.png

107 KB
Loading

0 commit comments

Comments
 (0)