Skip to content

Commit

Permalink
Merge pull request #40 from liauzhanyi/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
AbdulrahmanAlRammah authored Oct 2, 2024
2 parents 61adb08 + e9cf2e9 commit 4cc6c7a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@

![Ui](docs/images/Ui.png)

* This is **a sample project for Software Engineering (SE) students**.<br>
* This is **an address book for social workers**.<br>
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).
2 changes: 1 addition & 1 deletion docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<li><a href="{{baseUrl}}/UserGuide.html" class="nav-link">User Guide</a></li>
<li><a href="{{baseUrl}}/DeveloperGuide.html" class="nav-link">Developer Guide</a></li>
<li><a href="{{baseUrl}}/AboutUs.html" class="nav-link">About Us</a></li>
<li><a href="https://github.com/se-edu/addressbook-level3" target="_blank" class="nav-link"><md>:fab-github:</md></a>
<li><a href="https://github.com/AY2425S1-CS2103-F10-2/tp" target="_blank" class="nav-link"><md>:fab-github:</md></a>
</li>
<li slot="right">
<form class="navbar-form">
Expand Down

0 comments on commit 4cc6c7a

Please sign in to comment.