Skip to content

Commit 0ebaac2

Browse files
markuz5116markuz5116
authored
Merge branch 'master' into branch-update-ug-markuz5116
2 parents 2729e84 + 7ed67fc commit 0ebaac2

6 files changed

Lines changed: 101 additions & 42 deletions

File tree

‎docs/AboutUs.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
1919

2020
* Role: Project Advisor
2121

22-
### Jane Doe
22+
### Huang Zhenxin
2323

24-
<img src="images/johndoe.png" width="200px">
24+
<img src="images/hzxin.png" width="200px">
2525

26-
[[github](http://github.com/johndoe)]
27-
[[portfolio](team/johndoe.md)]
26+
[[github](http://github.com/Hzxin)]
27+
[[portfolio](team/hzxin.md)]
2828

29-
* Role: Team Lead
29+
* Role: Integration
3030
* Responsibilities: UI
3131

32-
### Johnny Doe
33-
34-
<img src="images/johndoe.png" width="200px">
32+
### Jeremias Shae
3533

36-
[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
34+
<img src="images/jeremias.jpg" width="200px">
3735

36+
[[github](http://github.com/jellymias)]
37+
[[portfolio](team/jellymias.md)]
3838
* Role: Developer
39-
* Responsibilities: Data
39+
* Responsibilities: Documentation, Testing
4040

4141
### Jean Doe
4242

‎docs/UserGuide.md‎

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,58 @@
11
---
2-
layout: page
3-
title: User Guide
2+
3+
RemindMe User Guide v1.1
44
---
5+
This user guide provide [start-up](#start-up) instructions as well as detailed descriptions and usage of
6+
all the [features](#features) in the RemindMe app. You can also access the product website via this [link.](https://ay2021s2-cs2103t-w15-1.github.io/tp/)
57

6-
RemindMe is a desktop app for keeping track of user events and deadlines,
7-
optimized for use via Command Line Interface(CLI) while still having the benefits of a Graphic User Interface(GUI).
8-
RemindMe allows students to be always aware of exams and events deadline as there will be reminder pop-ups and
9-
calendar for students to see!
8+
<div style="page-break-after: always;"></div>
109

11-
* Table of Contents
12-
{:toc}
10+
## Table of Contents
1311

14-
--------------------------------------------------------------------------------------------------------------------
12+
* **[Introduction](#introduction)**
13+
* **[Start-up](#Start-up)**
14+
* **[Features](#features)**
15+
* **[1. Show help page : `help`]()**
16+
* **[2. Add an event/examination]()**
17+
* **[3. Add an event/examination]()**
18+
* **[4. Delete an event/examination]()**
19+
* **[5. Edit a task]()**
20+
* **[6. Delete a task]()**
21+
* **[7. Calendar View]()**
22+
* **[8. Pop-up Reminder]()**
23+
* **[Glossary](#glossary)**
24+
* **[Command summary](#command-summary)**
1525

16-
## Quick start
26+
<div style="page-break-after: always;"></div>
1727

18-
1. Ensure you have Java 11 or above installed on your computer. You can download Java 11 via the link: https://www.oracle.com/sg/java/technologies/javase-jdk11-downloads.html
19-
If you are a Windows user, here is a tutorial on how to set up Java 11:
20-
https://java.tutorials24x7.com/blog/how-to-install-java-11-on-windows
28+
--------------------------------------------------------------------------------------------------------------------
29+
30+
## Introduction
31+
RemindMe is a desktop app for keeping track of user events and deadlines,
32+
optimized for use via Command Line Interface(CLI) while still having the benefits of a Graphic User Interface(GUI).
2133

22-
1. Download the latest `remindme.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
34+
Objectives of RemindMe:
35+
1. Allow students to be aware of deadlines of school events and exams.
36+
2. Allow students to have a calendar view of their school curriculums/schedules.
2337

24-
1. Copy the file to the folder you want to use as the home folder for your RemindMe.
2538

26-
1. Double click the file to start the app. Alternatively, you can run the command line java -jar RemindMe.jar in your terminal to start the application. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
27-
![Ui](images/Ui.png)
39+
## Start-up
2840

29-
1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
30-
Some example commands you can try:
41+
1. Ensure you have Java 11 or above installed on your computer. You can download Java 11 via this [link.](https://www.oracle.com/sg/java/technologies/javase-jdk11-downloads.html)
42+
* 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:
3143

32-
* **`list`** : Lists all contacts.
3344

34-
* **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.
45+
2. Download the latest RemindMe.jar from our GitHub release page.
46+
Copy the file to the folder you want to use as the home folder for your RemindMe.
47+
Double click the file to start the app.
48+
3549

36-
* **`delete`**`3` : Deletes the 3rd contact shown in the current list.
50+
3. Alternatively, you can run the command line java -jar RemindMe.jar in your terminal to start the application.
51+
Type the command in the command box and press Enter to execute it.
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)
3754

38-
* **`clear`** : Deletes all contacts.
55+
4. Refer to the Features below for details of each command.
3956

4057
* **`deadline`** `description by DD/MM/YYYY TIME`: Adds a task with a deadline.
4158

@@ -45,7 +62,6 @@ calendar for students to see!
4562

4663
* **`exit`** : Exits the app.
4764

48-
1. Refer to the [Features](#features) below for details of each command.
4965

5066
--------------------------------------------------------------------------------------------------------------------
5167

@@ -182,14 +198,9 @@ Exits the program.
182198

183199
Format: `exit
184200

185-
--------------------------------------------------------------------------------------------------------------------
186-
187-
## FAQ
188-
189-
**Q**: How do I transfer my data to another Computer?<br>
190-
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder.
191-
192-
--------------------------------------------------------------------------------------------------------------------
201+
## Glossary
202+
* Examination: Consists of a start time, end time, date which it occurs on and the subject.
203+
* Event: Consists of a start time, end time and the date which it occurs on.
193204

194205
## Command summary
195206

‎docs/images/hzxin.png‎

979 KB
Loading

‎docs/images/jeremias.jpg‎

57.3 KB
Loading

‎docs/team/hzxin.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: page
3+
title: Huang Zhenxin's Project Portfolio Page
4+
---
5+
6+
## Introduction
7+
This page serves to document my contributions to the project RemindMe under NUS module CS2103T in AY20/21 semester 2.
8+
9+
## Project: RemindMe
10+
11+
RemindMe is a desktop app for keeping track of user events and deadlines,
12+
optimized for use via Command Line Interface(CLI) while still having the benefits of a
13+
Graphic User e user interacts with it using a CLI, and it has a GUI created with JavaFX.
14+
It is written in Java.
15+
16+
Given below are my contributions to the project.
17+
18+
* **New Feature**: To be updated
19+
20+
* **Code contributed**: to be updated.
21+
22+
* **Project management**: to be updated
23+
24+
* **Enhancements to existing features**:
25+
* Come out with Ui-mockup(Pull requests [\#23](https://github.com/AY2021S2-CS2103T-W15-1/tp/pull/23))
26+
27+
* **Documentation**:
28+
* User Guide:
29+
* Added documentations for the introduction and Quick Start [\#25](https://github.com/AY2021S2-CS2103T-W15-1/tp/pull/25)
30+
* Developer Guide:
31+
* Added documentations for Target user profile, value proposition, and user stories.
32+
33+
* **Community**:
34+
* PRs reviewed (with non-trivial review comments): to be updated.
35+

‎docs/team/jellymias.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
layout: page
3+
title: Jeremias Shae's Project Portfolio Page
4+
---
5+
## Introduction
6+
This page serves to document my contributions to the RemindMe project.
7+
8+
## Project: RemindMe
9+
RemindMe is a desktop application to help users track their deadlines and important events.
10+
It is optimised for Command Line Interface (CLI) while still having the benefits of a
11+
Graphic User e user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java.
12+
13+
Given below are my contributions to the project:

0 commit comments

Comments
 (0)