From 4db93b999eb050b2e52e178f53ad7186301343f3 Mon Sep 17 00:00:00 2001 From: 1st2GetThisName Date: Sun, 6 Oct 2024 23:09:58 +0800 Subject: [PATCH] Update body of README README describes the project this project is based upon instead of this project. Let's update the body to describe this project. --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c83f29061e6..2ee86f56892 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,10 @@ ![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. +* This is an application made to assist **Customer Service Representatives (CSRs) of delivery companies**.
+* The application is used for managing contact details of the clients of CSRs. + * It is **written in OOP fashion**. * 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` ...). + * It is designed to cater to users with fast typing speeds. +* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). * For the detailed documentation of this project, see the **[ServiceTrack Product Website](https://ay2425s1-cs2103t-t17-2.github.io/tp/)**. -* 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 information.