[CS2103-F10-1] TAddressBook

README.md

@@ -1,14 +1,9 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# TAddressBook
+[![CI Status](https://github.com/AY2122S2-CS2103-F10-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S2-CS2103-F10-1/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.
+* **TAddressBook** is a student project based on [AddressBook Level 3](https://github.com/se-edu/addressbook-level3). It is a desktop application created with the aim of helping CS2030S Teaching Assistants (TAs) keep track of student's lab assignments.
+* It is named `TAddressBook` 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 **[TAddressBook Product Website](https://ay2122s2-cs2103-f10-1.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -25,6 +25,10 @@ test {
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'TAddressbook.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -2,58 +2,39 @@
 layout: page
 title: About Us
 ---
+# About Us
+We are team TAddressBook.
 
 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
-
-### Jane Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Team Lead
-* Responsibilities: UI
-
-### Johnny Doe
+### Bryan seah
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bryans17.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/bryans17)]
+[[portfolio](team/bryans17.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Team Lead, Integration
 
-### Jean Doe
+### Channe Chwa
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/channne.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/channne)]
+[[portfolio](team/channne.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Documentation, Testing
 
-### James Doe
+### Ryan Tan Gee Teng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/geetengtan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/geetengtan)]
+[[portfolio](team/geetengtan.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code Quality, Deliverables and deadlines

docs/SettingUp.md

@@ -45,7 +45,7 @@ If you plan to use Intellij IDEA (highly recommended):
 
 1. **Learn the design**
 
-   When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [AddressBook’s architecture](DeveloperGuide.md#architecture).
+   When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [TAddressBook’s architecture](DeveloperGuide.md#architecture).
 
 1. **Do the tutorials**
    These tutorials will help you get acquainted with the codebase.