[CS2103T-W16-2] ForgetfulNUS

README.md

@@ -1,14 +1,21 @@
-[![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-CS2103T-W16-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-W16-2/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.
+# Welcome to ForgetfulNUS!
+  ForgetfulNUS is a **flashcard application** designed to assist students currently learning the **German Language**,
+  specifically those undertaking the **NUS modules LAG1201 and LAG2201**, as a **memory aid for vocabulary**.
+* Example usages:
+  * Self-testing with a scoring system
+  * Build a user-customised glossary
+  * More to come!
+* As the app is still in early development, some features are still a work in progress. Expect to see more updates in the near
+    future!
+* While the app is usable by any party, some features cater *specifically* to NUS students undertaking LAG1201 and LAG2201
+
+## Additional links
+* For a full guide to ForgetfulNUS, see our **[ForgetfulNUS User Guide](https://github.com/AY2021S1-CS2103T-W16-2/tp/blob/master/docs/UserGuide.md)**
+* For the detailed documentation of this project, see our **[ForgetfulNUS Developer Guide](https://github.com/AY2021S1-CS2103T-W16-2/tp/blob/master/docs/DeveloperGuide.md)**.
+
+### Acknowledgements
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.forgetfulnus.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -40,6 +40,10 @@ task coverage(type: JacocoReport) {
     }
 }
 
+run {
+    enableAssertions = true
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'ForgetfulNUS.jar'
 }
 
 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](http://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 seer[at]comp.nus.edu.sg
 
 ## Project team
 
-### John Doe
+### Joe Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tjwjoe.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tjwjoe)] [[portfolio](team/tjwjoe.md)]
 
-* Role: Project Advisor
 
-### Jane Doe
+* Role: Developer
+* Responsibilities: Documentation
+
+### Kenny Seet
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kswk.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/kswk)] [[portfolio](team/kswk.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Deliverables, Deadlines and Integration
 
-### Johnny Doe
+### Rayasam Harshini
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/rayasamhr.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/rayasamhr)] [[portfolio](team/rayasamhr.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Code Quality
 
-### Jean Doe
+### Xu Zhizhi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zhizhizhizhizhi.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/zhizhizhizhizhi)] [[portfolio](team/zhizhizhizhizhi.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Testing
 
-### James Doe
+### Yang Jiyu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yangjiyu98.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/yangjiyu98)] [[portfolio](team/yangjiyu98.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Scheduling and Tracking

docs/DevOps.md

@@ -44,7 +44,7 @@ As part of CI, this project uses Codecov to generate coverage reports. Here are
 
 1. Sign up with Codecov using your GitHub account [here](https://codecov.io/signup).
 1. Once you are inside Codecov web app, add your fork to CodeCov.
-1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.
+1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/AY2021S1-CS2103T-W16-2/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-W16-2/tp) in that page reflects the coverage of your project.
 
 ### Repository-wide checks