diff --git a/README.md b/README.md index 2854b15bbef..76b22f72a5c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ -[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) -[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-F14-2/tp/graph/badge.svg?token=T5H5FY1BYS)](https://codecov.io/gh/AY2324S2-CS2103T-F14-2/tp) +[![CI Status](https://github.com/AY2324S2-CS2103T-F14-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S2-CS2103T-F14-2/tp/actions/workflows/gradle.yml) +[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-F14-2/tp/graph/badge.svg?token=T5H5FY1BYS)](https://codecov.io/gh/AY2324S2-CS2103T-F14-2/tp) ![Ui](docs/images/Ui.png) -* This is **a sample project for Software Engineering (SE) students**.
- 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. +The project simulates an ongoing software project for a desktop application (called _Clinic Mate_) used for managing contact details. +* It is **written in OOP fashion**. It provides a **reasonably well-written** code base. +* It comes with a **reasonable level of user and developer documentation**. + +Clinic Mate is an **address book for managing user's contacts, optimised for use via a Command Line Interface** (CLI) while +still having the benefits of a Graphical User Interface (GUI). +If you can type fast, Clinic Mate can manage your contacts faster than traditional GUI apps. + +Clinic Mate aims to make it easy for **General Practitioners** (GPs) in private family clinics to view patient contacts at +a glance including: +* Medical history +* Past diagnosis +* Prescriptions +* Future appointments +* Many more + +For the detailed documentation of this project (e.g. User or Developer Guide), see the **[Clinic Mate Website](https://ay2324s2-cs2103t-f14-2.github.io/tp/)**. + +This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 5123a969436..a3aa51d4765 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -23,7 +23,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo 1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
- ![Ui](images/Ui.png) + ![Ui](images/OldUi.png) 1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
Some example commands you can try: diff --git a/docs/images/OldUi.png b/docs/images/OldUi.png new file mode 100644 index 00000000000..5bd77847aa2 Binary files /dev/null and b/docs/images/OldUi.png differ diff --git a/docs/images/Ui.png b/docs/images/Ui.png index 5bd77847aa2..47dadf61e20 100644 Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ diff --git a/docs/index.md b/docs/index.md index 904d2ebd40f..a143bbb4e18 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) -![Ui](images/Ui.png) +![Ui](images/OldUi.png) **AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).