[CS2103T-W12-2] TeaPet

README.adoc

@@ -1,8 +1,8 @@
-= Address Book (Level 3)
+= TeaPet
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
 https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
+https://travis-ci.org/AY1920S2-CS2103T-W12-2/main?utm_medium=notification&utm_source=github_status[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
 https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
 https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
 
@@ -15,15 +15,17 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
+* TeaPet is an all-in-one desktop program for primary school form teachers to *manage their classroom effectively*.
+It manages your *personal curriculum schedule*, *student particulars*, and can also *track your class progress* all in
+one simple program.
+* TeaPet flexes its simple and clean Graphical User Interface (GUI)
+* TeaPet is optimized for those who prefer to work with a *Command Line Interface (CLI)* while still having a simple
+and clean Graphical User Interface (GUI).
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
@@ -32,5 +34,6 @@ endif::[]
 * Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
 _Marco Jakob_.
 * Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* Morphed original source code from AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
 
 == Licence : link:LICENSE[MIT]

_config.yml

@@ -1 +1,3 @@
 theme: jekyll-theme-cayman
+title: Teapet
+description: TeaPet is an all-in-one desktop program for primary school form teachers to manage their classroom effectively. It manages your personal curriculum schedule, student particulars, and can also track your class progress all in one simple program.

docs/AboutUs.adoc

@@ -4,53 +4,55 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
+TeaPet - TeaPet was developed by us. +
+
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== Simon Lam
+image::theelectricblender.png[width="150", align="left"]
+{empty}[https://github.com/TheElectricBlender[github]] [<<theelectricblender#, portfolio>>]
 
-Role: Project Advisor
+Role: Team Leader +
+Responsibility: In charge of overall progress and direction of project.
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Zhang Yuanyu
+image::yuanyu97.png[width="150", align="left"]
+{empty}[http://github.com/Yuanyu97[github]] [<<yuanyu97#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Git master +
+Responsibility: Help team members to get familiar with git tools.
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Gary Lim
+image::garysyndromes.png[width="150", align="left"]
+{empty}[http://github.com/garysyndromes[github]] [<<garysyndromes#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Integration +
+Responsibilities: In charge of versioning of the code, maintaining the code repository, integrating various parts of the
+software to create a whole.
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Gerren Seow
+image::jerrenss.png[width="150", align="left"]
+{empty}[http://github.com/jerrenss[github]] [<<jerrenss#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Scheduling and Tracking +
+Responsibilities: In charge of defining, assigning and tracking project tasks.
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Lee Huiting
+image::tingalinga.png[width="150", align="left"]
+{empty}[http://github.com/tingalinga[github]] [<<tingalinga#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: Code quality and Documentation +
+Responsibilities: Looks after the code, ensures adherence to coding standard. Also responsible of the quality of various
+project documents.
 
 '''

docs/ContactUs.adoc

@@ -3,5 +3,11 @@
 :stylesDir: stylesheets
 
 * *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
-* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+
+* *Email us* : You can also reach us at +
+** `[email protected]`
+** `[email protected]`
+** `[email protected]`
+** `[email protected]`
+** `[email protected]`
+