Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2425S1#33 from 1st2GetThisName/branch…
Browse files Browse the repository at this point in the history
…_update_readme

Update body of README
  • Loading branch information
Judy1x4 authored Oct 8, 2024
2 parents 4e5cf65 + 4db93b9 commit d828b1f
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@

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

* This is **a sample project for Software Engineering (SE) students**.<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.
* 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**.<br>
* 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.

0 comments on commit d828b1f

Please sign in to comment.