[CS2103T-T12-2] d'Intérieur

README.md

@@ -1,14 +1,25 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![Java CI](https://github.com/AY2122S2-CS2103T-T12-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2122S2-CS2103T-T12-2/tp/actions/workflows/gradle.yml)
 
 ![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.
+# d'Intérieur - address book for interior designers
+An address book app built with Java and JavaFX (see acknowledgements), enhanced for interior designers.
+
+## Introduction
+* This is **an address book application designed for interior designers**.<br>
+  * quick-add functionality, add your contact details quickly on-the-fly
+  * filter and search through your contacts
+    * perfect for getting your contacts based on type of contact (ongoing clients, favourite contractors)
+  * add notes to keep track of the minor details
+
+## User Guide
+- If you are interested to use our app, head over to the [_quick start_ section of our **User Guide**](https://ay2122s2-cs2103t-t12-2.github.io/tp/UserGuide.html#quick-start).
+
+## Developer Guide
+- If you are interested to develop the app, head over to the [**Developer Guide**](https://ay2122s2-cs2103t-t12-2.github.io/tp/DeveloperGuide.html) to get started.
+
+## About Us
+- To learn more about the _awesome_ developers for this project, head over to our [**About Us** page](https://ay2122s2-cs2103t-t12-2.github.io/tp/AboutUs.html).
+
+## Acknowledgements
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -25,6 +25,11 @@ test {
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)

copyright.txt

@@ -7,3 +7,6 @@ Copyright by Susumu Yoshida - http://www.mcdodesign.com/
 Copyright by Jan Jan Kovařík - http://glyphicons.com/
 - calendar.png
 - edit.png
+
+Copyright by https://www.rawpixel.com/image/2512749/free-illustration-png-font-handwritten-abstract-alphabet
+- d_interieur.png

docs/AboutUs.md

@@ -5,55 +5,55 @@ 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
+### David Limantara
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/xsaints19x.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/xSaints19x)]
+[[portfolio](team/xsaints19x.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: UI
 
-### Jane Doe
+### Ezekiel Toh Fun Kai
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/takufunkai.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/takufunkai)]
+[[portfolio](team/takufunkai.md)]
 
-* Role: Team Lead
+* Role: Developer
 * Responsibilities: UI
 
-### Johnny Doe
+### Glenn Lim Jun Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/glennljw.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/glennljw)]
+[[portfolio](team/glennljw.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI
 
-### Jean Doe
+### Teh Kok Hoe
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tehkokhoe.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tehkokhoe)]
+[[portfolio](team/tehkokhoe.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Deadline and Sort feature
 
-### James Doe
+### Yoong Wei Jue
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/weijuey.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/weijuey)]
+[[portfolio](team/weijuey.md)]
 
 * Role: Developer
 * Responsibilities: UI