Skip to content

Commit

Permalink
Merge pull request #20 from Jollybomber/userGuide
Browse files Browse the repository at this point in the history
User guide
  • Loading branch information
kohkakohla authored Oct 4, 2024
2 parents 659710e + 2b6049a commit 731c2db
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,10 @@

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

* This is **a sample project for Software Engineering (SE) students**.<br>
* This is **a contact management app for volunteers called VolunTier**.<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/#contributing-to-se-edu) for more info.
* Add new volunteers and their relevant details
* List all seniors that volunteers are visiting
* It is named `VolunTier` as it is a top Tier solution for Volunteer supervisors!
* For the detailed documentation of this project, see the **[Address Book Product Website](https://ay2425s1-cs2103t-f08-1a.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 731c2db

Please sign in to comment.