From 6e107c0c7160e46f5f86683b69b11a4dec726756 Mon Sep 17 00:00:00 2001 From: Nereus Ng Wei Bin Date: Mon, 13 Nov 2023 20:53:54 +0800 Subject: [PATCH] Update readme file --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5ad49939f3f..dd760f71fdb 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,23 @@ ## Introducing our product - ProfBook -ProfBook provides easy management of tasks, group schedules, and notes for every tutorial slot and group. A CS professor -friendly platform to keep updated and informed with notifications and profile pictures of your students for a personal -touch and easy recognition of students during lessons. +**ProfBook** is a dedicated desktop application tailored for **CS2103T tutors**, enabling efficient task management and student oversight within a single tutorial slot. It simplifies the handling of tasks and provides a comprehensive student management system, offering a personalized touch through student profiles for easy recognition during lessons. -* This is an application for CS professor to manage tasks, group schedules, and notes of every tutorial slot and group - effectively. -* It is named `ProfBook` because it aims to help professors to keep track of the many tutorial groups as well as the +It is named `ProfBook` because it aims to help professors to keep track of the many tutorial groups as well as the many deadlines and submission. -**Features** +### Features -* Create Todo task for student or group of student -* Create Deadline task for student or group of student -* Create a group and move student into a group -* Mark task done for every student in a group -* Add profile pictures of students -* Store notes or links related to each group or tutorial +* Create, edit or delete groups +* Add, edit, or delete students +* Move students among groups +* Create and assign todo or deadline tasks for students or groups +* Mark, unmark or remove task + +### Guides + +Explore our [User Guide](https://ay2324s1-cs2103t-w15-2.github.io/tp/) for detailed instructions on using **ProfBook**.
+For developers, our [Developer Guide](https://ay2324s1-cs2103t-w15-2.github.io/tp/DeveloperGuide.html) offers insights into the application's architecture, future enhancement, and more.