diff --git a/README.md b/README.md index e225e17340d..a4e31566226 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,17 @@ ![Ui](docs/images/Ui.png) -* This is **a sample project for Software Engineering (SE) students**.
+* This is **an address book for social workers**.
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. + * as an easy way to locate/contact families. + * keep track of how long it has been since their last visit. + +* The project simulates an ongoing software project for a desktop application (called _SocialBook_) 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. + +* For the detailed documentation of this project, see the **[SocialBook Product Website](https://ay2425s1-cs2103-f10-2.github.io/tp)**. + +## Acknowledgements +This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). diff --git a/docs/_markbind/layouts/default.md b/docs/_markbind/layouts/default.md index ea16467e280..18086f29834 100644 --- a/docs/_markbind/layouts/default.md +++ b/docs/_markbind/layouts/default.md @@ -9,7 +9,7 @@
  • User Guide
  • Developer Guide
  • About Us
  • -
  • :fab-github: +
  • :fab-github: