Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2324S1#24 from FerdiHS/update-readme-…
Browse files Browse the repository at this point in the history
…content

update readme contents for PropertyMatch
  • Loading branch information
Chrainx authored Oct 1, 2023
2 parents 2a0b288 + 51f1a1e commit 04e7c53
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@

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

# PropertyMatch
Are you a new property agent starting to jump to the real estate world?
Do you feel overwhelmed of remembering properties' features and your clients' preferences?
We have the right tool for you!

* 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.
* 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)**.
Introducing PropertyMatch, the real estate tracking application made just for you!

## Features
- [ ] Add new properties
- [ ] Add new customers
- [ ] Delete existing properties
- [ ] Delete existing customers
- [ ] List all properties
- [ ] List all customers

## Others
* 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#https://se-education.org/#contributing) for more info.
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

0 comments on commit 04e7c53

Please sign in to comment.