[CS2103T-T17-4] Abπ

README.md

@@ -1,14 +1,17 @@
-[![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/AY2122S2-CS2103T-T17-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S2-CS2103T-T17-4/tp/actions)
 
 ![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.
+AddressBook pi (**Abπ**) is a 360° all-rounded desktop app for managing contacts, optimized for use via a Command Line Interface (CLI). Abπ is catered towards fast-typers and individuals who want an organized address book with key features including efficient filtering of contacts based on various attributes (name, email, tags, etc.), copying of all emails in the address book and a memo section that allows you to note down notable details about a person.
+
+## Site Map
+
+* **[Abπ Product Website](https://ay2122s2-cs2103t-t17-4.github.io/tp/)**
+* **[User Guide](https://ay2122s2-cs2103t-t17-4.github.io/tp/UserGuide.html)**
+* **[Developer Guide](https://ay2122s2-cs2103t-t17-4.github.io/tp/DeveloperGuide.html)**
+* **[About Us](https://ay2122s2-cs2103t-t17-4.github.io/tp/AboutUs.html)**
+* **[Releases](https://github.com/AY2122S2-CS2103T-T17-4/tp/releases)**
+
+## Acknowledgement
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -69,4 +69,8 @@ shadowJar {
     archiveName = 'addressbook.jar'
 }
 
+run {
+    enableAssertions = true
+}
+
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,42 @@ 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`
+You can reach us at the email `e0544426@u.nus.edu` or `[email protected]`.
 
 ## Project team
 
-### John Doe
+### Alvin Tay Ming Hwee
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/atmh.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[github](https://github.com/atmh) | [portfolio](team/atmh.md)
 
-* Role: Project Advisor
+* Role: Scheduling and tracking.
+* Responsibilities: In charge of defining, assigning, and tracking project tasks.
 
-### Jane Doe
+### Huang Xing Chen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lovemathboy.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[github](http://github.com/lovemathboy) | [portfolio](team/lovemathboy.md)
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Code Quality.
+* Responsibilities: Looks after code quality, ensures adherence to coding standards.
 
-### Johnny Doe
+### Tan De Shao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tandeshao.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[github](http://github.com/tandeshao) | [portfolio](team/tandeshao.md)
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Deliverables and deadlines.
+* Responsibilities: Ensure project deliverables are done on time and in the right format.
 
-### Jean Doe
+### Xu Peizhe
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/xpzmichael.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[github](http://github.com/xpzmichael) | [portfolio](team/xpzmichael.md)
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
-
-### James Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Developer
-* Responsibilities: UI
+* Role: Documentation.
+* Responsibilities: Responsible for the quality of various project documents.