Skip to content

Commit

Permalink
Merge pull request #28 from hm-yang1/update-readme
Browse files Browse the repository at this point in the history
Update README with LogiLink information
  • Loading branch information
hm-yang1 authored Oct 2, 2024
2 parents c474c66 + d960f7a commit 7a26e26
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@

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

* This is **a sample project for Software Engineering (SE) students**.<br>
* This is a **delivery management application** for logistic companies.<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.
* Logistics managers can track their shipments
* Logistics managers can also access information for all their customers
* The project simulates an ongoing software project for a desktop application 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.
* It is named `LogiLink` as it aims to be the link between logistic managers and their deliveries
* For the detailed documentation of this project, see the **[LogiLink Product Website](https://github.com/AY2425S1-CS2103T-T12-3/tp)**.

0 comments on commit 7a26e26

Please sign in to comment.