From eedbed987c746b5651df7b9954e3702425796b27 Mon Sep 17 00:00:00 2001 From: Xan Date: Thu, 3 Oct 2024 21:53:56 +0800 Subject: [PATCH] Update README to match project --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 16208adb9b6..ea142b8c197 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) - +# ContactsForGood (CFG) ![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` ...). -* 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, `ContactsForGood (CFG)` is an extension of the `AB3` project targeted towards NGO administrators.' +* It contains improvements and new features which are of specific benefit to NGO administrators and their work. +* The details of the original AB3 project are included below: + * 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` ...). + * 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.