[CS2103T-T09-1] GradPad

README.md

@@ -1,14 +1,42 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2021S1-CS2103T-T09-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-T09-1/tp/actions)
+
+# GradPad
+
+GradPad is a one-stop solution to **module management** for Computer Science Undergraduates.
+Planning for modules has always been a tedious process but it does not have to be.
+
+The current approach to planning and tracking graduation requirements is to open up tabs after tabs of NUS resources such as 
+[NUSMods](https://nusmods.com/) and [websites](https://www.comp.nus.edu.sg/programmes/ug/cs/curr/) of the School of
+ Computing, which can be messy at times. 
+So, the GradPad team has come up with the idea of an **easy-to-use**, **all-in-one application** that
+can ease the process of **module management** for Computer Science Undergraduates.
+
+GradPad **consolidates** the modules you have taken and **displays** the remaining required modules to
+ease your module planning process. A **module searching platform** is also included in GradPad, providing easy
+**navigation** of modules.
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+## Installation
+### Requirements
+GradPad requires that you have a Java SE Runtime Environment (JRE) installed on your machine.
+
+### Steps
+1. Download the latest jar release of GradPad from this repository.
+2. Run the downloaded jar file
+    - You can either double-click on the jar file, or
+    - Execute this command from your terminal: `java -jar GradPad.jar`
+
+## Usage
+For detailed guidance on using GradPad, take a look at our user guide 
+[here](https://ay2021s1-cs2103t-t09-1.github.io/tp/UserGuide.html).
+
+For developers, view our detailed documentation 
+[here](https://ay2021s1-cs2103t-t09-1.github.io/tp/DeveloperGuide.html).
+
+## Contributing
+Although GradPad is an open source project, it is currently not open to public contribution.
+
+## Authors and acknowledgement
+This project is based on the AddressBook-Level3 project created by the 
+[SE-EDU initiative](https://se-education.org).

build.gradle

@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'gradpad.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,46 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
-
 ## Project team
 
-### John Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
+### Lau Siaw Sam
 
-### Jane Doe
+<img src="images/silvernitro.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/silvernitro)]
+[[portfolio](team/silvernitro.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: Testing
 
-### Johnny Doe
+### Lim Shao Kiat
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shaokiat.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/shaokiat)]
+[[portfolio](team/shaokiat.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Documentation
 
-### Jean Doe
+### Muhammad Syafiq Bin Abas
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/mhdsyfq.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/mhdsyfq)]
+[[portfolio](team/mhdsyfq.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Code Quality
 
-### James Doe
+### Soon Xiang, Yan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yan-soon.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/yan-soon)]
+[[portfolio](team/yan-soon.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Deliverables and deadlines
+
+