Skip to content

Commit

Permalink
Merge pull request #41 from darkvoid32/branch-Update-README
Browse files Browse the repository at this point in the history
Updated README.md
  • Loading branch information
rizkidelta authored Mar 4, 2024
2 parents 32215b9 + 374dacd commit 1d4aeab
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
[![CI Status](https://github.com/AY2324S2-CS2103T-W12-3/tp/workflows/Java%20CI/badge.svg)](hhttps://github.com/AY2324S2-CS2103T-W12-3/tp/actions)
[![CI Status](https://github.com/AY2324S2-CS2103T-W12-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W12-3/tp/actions)
[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W12-3/tp/graph/badge.svg?token=ZAZ8O2FN70)](https://codecov.io/gh/AY2324S2-CS2103T-W12-3/tp)

![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.
* 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.
## AssetBook-3

AssetBook-3 is a desktop application for logistics managers to keep track point-of-contacts' (POCs) contact information, along with their relevant assets. It is meant for those who have too many POCs and assets, and wish to easily retrieve contact details based on name, tag, or asset ID.

## Acknowledgement

This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
Binary file modified docs/images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1d4aeab

Please sign in to comment.