From 34e78997f30f6776363c160bca251609cf406bc7 Mon Sep 17 00:00:00 2001 From: Caden <63772723+cadencjk@users.noreply.github.com> Date: Wed, 12 Oct 2022 03:02:37 +0800 Subject: [PATCH] Update Readme --- README.md | 12 ++++-------- docs/index.md | 2 +- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 47c01884518..a252d21de6a 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,10 @@ ![Ui](docs/images/Ui.png) -* This is **a 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 `Teacher's Pet` (`TP` for short) because it was designed to target the needs of teachers. +* Teacher’s Pet is a desktop application for managing contacts of students and classes, 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, Teacher’s +Pet can get your contact and class management tasks done faster than traditional GUI apps. +* It is named `Teacher's Pet` (`TP` for short) because it was designed to assist teachers. * For the detailed documentation of this project, see the **[Teacher's Pet Product Website](https://ay2223s1-cs2103t-t09-4.github.io/tp/)**. * 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. * This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). diff --git a/docs/index.md b/docs/index.md index f3e1d310ef5..51c9078fe30 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ --- layout: page -title: AddressBook Level-3 +title: Teacher's Pet --- [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)