Skip to content

Commit

Permalink
Merge pull request #20 from kjw142857/update-readme
Browse files Browse the repository at this point in the history
Fixes #10 Edit README.md to reflect project scope
  • Loading branch information
Joseph31416 authored Mar 7, 2024
2 parents 0035d59 + 1243ec8 commit 320fafc
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![CI Status](https://github.com/AY2324S2-CS2103T-W13-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W13-1/tp/actions)

[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W13-1/tp/graph/badge.svg?token=MZAGQZIFNS)](https://codecov.io/gh/AY2324S2-CS2103T-W13-1/tp)

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

* This is **a sample project for Software Engineering (SE) students**.<br>
* This is **LoanGuard Pro, an application that helps business owners manage clients and their loan details**.<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.
* to keep track of the items you have loaned out
* to view your history of loans by client
* The project builds on an existing Address Book used for managing contact details, **adding in a loan tracker functionality**.
* 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` ...).
* 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#https://se-education.org/#contributing) for more info.
* It is named `LoanGuard Pro` because it represents a more powerful version of an address book, that can also manage the loans of your contacts.
* For the detailed documentation of this project, see the **[LoanGuard Pro Product Website](https://ay2324s2-cs2103t-w13-1.github.io/tp/)**.
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

0 comments on commit 320fafc

Please sign in to comment.