Skip to content

Commit

Permalink
Merge pull request #31 from lm-44/Update-README.md
Browse files Browse the repository at this point in the history
Update readme.md
  • Loading branch information
lm-44 authored Sep 25, 2024
2 parents d9cfe13 + f28e58f commit 3395aba
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103-F11-1/tp/actions)

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

* This is **a sample project for Software Engineering (SE) students**.<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.
test
TAchy helps tech-saavy tutors and tuition teachers manage details of their students and classes. It is optimized for CLI users so that frequent tasks can be done faster by typing in commands.
* Provide a fast CLI for tutors to manage and track students' work and submissions.
* Provides an efficient CLI for tutors to plan and manage classes
* Provides some interface for arranging classes

* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

0 comments on commit 3395aba

Please sign in to comment.