[CS2103T-W13-1] ScoopBook

README.md

@@ -1,14 +1,23 @@
-[![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/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S2-CS2103T-W13-1/tp/actions)
+# ScoopBook
 ![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/#contributing-to-se-edu) for more info.
+# Overview
+ScoopBook is a lightweight **desktop application** to manage your contacts. Specialised and catered to journalists seeking a faster and offline solution to efficiently manage their contacts.
+
+## Features
+ScoopBook provides journalists with a simple and efficient way to manage their contacts. It allows users to:
+* Add and manage contacts
+* Tag contacts for better organisation
+* Add notes for each contact to keep track of important information
+* Import and export contacts for easy transfer
+
+For more information, check out the [ScoopBook Project Website](https://ay2425s2-cs2103t-w13-1.github.io/tp/).
+
+## Authors
+Find out more about us on our [About Us](https://ay2425s2-cs2103t-w13-1.github.io/tp/AboutUs.html) page!
+
+## Acknowledgements
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). <br>
+We would also like to thank all professors, TAs, coursemates and friends who have helped and supported us throughout the project.
+

build.gradle

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

docs/AboutUs.md

@@ -5,55 +5,52 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](https://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 `shawn.goh@u.nus.edu`
 
 ## Project team
 
-### John Doe
+### Shawn Goh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shawnnygoh.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](https://shawnnygoh.github.io/)]
+[[github](https://github.com/shawnnygoh)]
 
-* Role: Project Advisor
+* Role: Deliverables and Deadlines
 
-### Jane Doe
+### Freddie Ong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/souledfigurine.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/souledfigurine)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Testing
+* Responsibilities: unconfirmed
 
-### Johnny Doe
+### Chua Wen Ting
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/wentingchua.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/wentingchua)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Scheduling and tracking: In charge of defining, assigning, and tracking project tasks.
 
-### Jean Doe
+### Soh Tze Jen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/meatsushi64.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Meatsushi64)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
 
-### James Doe
+* Role: Developer, Integration
+* Responsibilities: In addition to developing, also in charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole.
+
+### Timothy Tay (tim0tay)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tim0tay.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tim0tay)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code Quality