[CS2103-T14-1] FaculType

README.md

@@ -1,14 +1,18 @@
-[![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/AY2021S1-CS2103-T14-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-T14-1/tp/actions)
+
+# FaculType
 
 ![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.
+**FaculType** is a desktop app for managing faculty members and their modules, optimized for use via a Command Line
+ Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).
+
+ In the current version, **FaculType** targets faculty leaders of universities who are responsible for managing faculty members and modules.
+
+# Site Map
+* [User Guide](https://github.com/AY2021S1-CS2103-T14-1/tp/blob/master/docs/UserGuide.md)
+* [Developer Guide](https://github.com/AY2021S1-CS2103-T14-1/tp/blob/master/docs/DeveloperGuide.md)
+* [About Us](https://github.com/AY2021S1-CS2103-T14-1/tp/blob/master/docs/AboutUs.md)
+
+# Acknowledgements
+This project is based on the *AddressBook-Level3* project created by the [SE-EDU initiative](https://se-education.org)

build.gradle

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,13 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'FaculType.jar'
+}
+
+gradle.projectsEvaluated {
+    tasks.withType(JavaCompile) {
+        options.compilerArgs << "-Xlint:unchecked"
+    }
 }
 
 defaultTasks 'clean', 'test'

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 Justin Tzuriel Krisnahadi
+- facultype_icon.png

docs/AboutUs.md

@@ -9,51 +9,52 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Justin Tzuriel Krisnahadi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/justintzuriel.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/justintzuriel)]
+[[portfolio](team/justintzuriel.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: Deliverables and deadlines
 
-### Jane Doe
+### Christian Drake Martin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/drake25122000.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/drake25122000)]
+[[portfolio](team/drake25122000.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Code quality
 
-### Johnny Doe
+### Erin May Gunawan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/erinmayg.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/erinmayg)]
+[[portfolio](team/erinmayg.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI
 
-### Jean Doe
+### Florencia Martina
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/florenciamartina.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/florenciamartina)]
+[[portfolio](team/florenciamartina.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Documentation
 
-### James Doe
+### Woo Jian Zhe
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jzwoo.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jzwoo)]
+[[portfolio](team/jzwoo.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Testing