From fb7a28190c312d40138d83b9df90c822a6704d7b Mon Sep 17 00:00:00 2001 From: Jollybomber Date: Thu, 26 Sep 2024 23:31:25 +0800 Subject: [PATCH 1/2] Update README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 16208adb9b6..6f21b61f7e7 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,4 @@ * 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/#contributing-to-se-edu) for more info. +* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). From 2b6049ac60a873bf20bfaee92efa4e31fcaaa1df Mon Sep 17 00:00:00 2001 From: Jollybomber Date: Fri, 4 Oct 2024 10:34:31 +0800 Subject: [PATCH 2/2] Update README --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e4306daba83..f7568ad4821 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,10 @@ ![Ui](docs/images/Ui.png) -* This is **a sample project for Software Engineering (SE) students**.
+* This is **a contact management app for volunteers called VolunTier**.
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/#contributing-to-se-edu) for more info. + * Add new volunteers and their relevant details + * List all seniors that volunteers are visiting +* It is named `VolunTier` as it is a top Tier solution for Volunteer supervisors! +* For the detailed documentation of this project, see the **[Address Book Product Website](https://ay2425s1-cs2103t-f08-1a.github.io/tp/)**. * This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).