[CS2103T-T13-4] ModuleMateFinder

README.md

@@ -1,14 +1,21 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![codecov](https://codecov.io/gh/AY2122S2-CS2103T-T13-4/tp/branch/master/graph/badge.svg?token=7ST0L6C9AY)](https://codecov.io/gh/AY2122S2-CS2103T-T13-4/tp)
+[![CI Status](https://github.com/AY2122S2-CS2103T-T13-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S2-CS2103T-T13-4/tp/actions)
 
+## ModuleMateFinder
 ![Ui](docs/images/Ui.png)
+Ever find it difficult to keep track of what modules your friends are taking?  
+Want to form groups with friends for certain modules, but don't know what they are taking?
 
-* 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.
+
+Worry not! With ModuleMateFinder, you can:
+1) Add friends into ModuleMateFinder, and their contact details
+2) Keep track of what modules they are taking
+3) Favourite people who you want to work with the most
+4) Blacklist people who you want to **avoid** working with
+5) Find people by the modules they are taking
+6) Many more...
+
+
+- Head over to the [User Guide](https://ay2122s2-cs2103t-t13-4.github.io/tp/UserGuide.html) to find out more
+
+**This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).**

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

build.gradle

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

docs/AboutUs.md

@@ -9,51 +9,53 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Bryan Tan Jing Kai
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/fantablack.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/fantablack)]
+[[portfolio](team/fantablack.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Developer
 
-### Jane Doe
+### Benjamin Tay Keck Bin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/btaykb.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Btaykb)]
+[[portfolio](team/btaykb.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Code, Documentation
 
-### Johnny Doe
+### Julio Harjo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/junlee1991.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/junlee1991)] 
+[[portfolio](team/junlee1991.md)]
 
 * Role: Developer
 * Responsibilities: Data
 
-### Jean Doe
+### Wei Jie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bakano98.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/bakano98)]
+[[portfolio](team/bakano98.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: GUI, features enhancement
+
+### Law Wei Ming
 
-### James Doe
+<img src="images/lawwm.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/lawwm)]
+[[portfolio](team/lawwm.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
 * Role: Developer
 * Responsibilities: UI