[W13-4] TutorHelper

README.adoc

@@ -1,10 +1,9 @@
-= Address Book (Level 4)
+= TutorHelper
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
+https://travis-ci.org/CS2103-AY1819S1-W13-4/main[image:https://travis-ci.org/CS2103-AY1819S1-W13-4/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/lywjoel/main[image:https://ci.appveyor.com/api/projects/status/fl2g22tv19e55iq4?svg=true[Build Status]]
+https://coveralls.io/github/CS2103-AY1819S1-W13-4/main?branch=master[image:https://coveralls.io/repos/CS2103-AY1819S1-W13-4/main/badge.svg?branch=master[Coverage Status]]
 https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
 
 ifdef::env-github[]
@@ -15,24 +14,22 @@ 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.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
+* This is a desktop TutorHelper 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 Tutors who would like to organise their students' information.
+* This application contains:
+** A GUI that includes a list panel and a details panel.
+** Test cases, including automated GUI testing.
 ** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
-
+* This application was adapted from https://github.com/nus-cs2103-AY1819S1/addressbook-level4[AddressBook4]
 * 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://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]

_reposense/config.json

@@ -0,0 +1,30 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "andlimey",
+      "displayName": "Andy Chan",
+      "authorNames": ["andlimey", "Andy", "DESKTOP-4O94ROD\\Andy"]
+    },
+    {
+      "githubId": "SusterDrifter",
+      "displayName": "Anthony Halim",
+      "authorNames": ["SusterDrifter"]
+    },
+    {
+      "githubId": "lywjoel",
+      "displayName": "Joel Lee",
+      "authorNames": ["lywjoel", "Joel Lee"]
+    },
+    {
+      "githubId": "ongyz",
+      "displayName": "Ong Yan Zhi",
+      "authorNames": ["ongyz"]
+    },
+    {
+      "githubId": "ooihuiying",
+      "displayName": "Ooi Hui Ying",
+      "authorNames": ["ooihuiying"]
+    }
+  ]
+}

build.gradle

@@ -207,9 +207,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
-        'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+        'site-name': 'TutorHelper',
+        'site-githuburl': 'https://github.com/CS2103-AY1819S1-W13-4/main',
     ]
 
     options['template_dirs'].each {

docs/AboutUs.adoc

@@ -4,51 +4,51 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 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.}_ +
+TutorHelper was developed by the https://github.com/CS2103-AY1819S1-W13-4[CS2103-AY1819S1-W13-4] team. +
 {empty} +
 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>>]
+=== Andy Chan
+image::andlimey.png[width="150", align="left"]
+{empty}[https://github.com/andlimey[github]] [<<johndoe#, portfolio>>]
 
-Role: Project Advisor
+Role: Developer +
+Responsibilities: UI
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Anthony Halim
+image::susterdrifter.png[width="150", align="left"]
+{empty}[http://github.com/SusterDrifter[github]] [<<johndoe#, portfolio>>]
 
-Role: Team Lead +
+Role: Developer +
 Responsibilities: UI
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Joel Lee
+image::lywjoel.png[width="150", align="left"]
+{empty}[http://github.com/lywjoel[github]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
 Responsibilities: Data
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Ong Yan Zhi
+image::ongyz.png[width="150", align="left"]
+{empty}[http://github.com/ongyz[github]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
 Responsibilities: Dev Ops + Threading
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Ooi Hui Ying
+image::ooihuiying.png[width="150", align="left"]
+{empty}[http://github.com/ooihuiying[github]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
 Responsibilities: UI

docs/ContactUs.adoc

@@ -2,6 +2,5 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/CS2103-AY1819S1-W13-4/main/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`