diff --git a/README.md b/README.md index 4fd018156f5..7d6e24118b6 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,17 @@ ![Ui](docs/images/Ui.png) -* This is **a sample project for Software Engineering (SE) students**.
- 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` ...). +* This is **an app for CS instructors that helps manage weaker students**.
+* The project is based on an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details. We have made several enhancements to it (see example usages). + +* Example usages: + * forming focus groups of weaker students + * visualising the performance of weaker students over time + * dedicating tutors and other resources to helping weaker students + +* It is **written in OOP fashion**. It provides a **well-written** code base of around 10k LOC. +* It comes with a **reasonable level of user and developer documentation**. +* It is named **“TeachStack”** as a pun on heap and stack. + * For the detailed documentation of this project, see the **[TeachStack Product Website](https://ay2324s2-cs2103t-t09-1.github.io/tp/)**. * This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). diff --git a/docs/images/Ui.png b/docs/images/Ui.png index 5bd77847aa2..26ede5a9d5f 100644 Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ