Skip to content

Commit

Permalink
Merge pull request #16 from willowisp01/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
willowisp01 authored Feb 29, 2024
2 parents 7ee113a + 60bf68d commit d816339
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@

![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` ...).
* This is **an app for CS instructors that helps manage weaker students**.<br>
* The project is based on an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details. We have made several enhancements to it (see example usages).

* Example usages:
* forming focus groups of weaker students
* visualising the performance of weaker students over time
* dedicating tutors and other resources to helping weaker students

* It is **written in OOP fashion**. It provides a **well-written** code base of around 10k LOC.
* It comes with a **reasonable level of user and developer documentation**.
* It is named **“TeachStack”** as a pun on heap and stack.

* For the detailed documentation of this project, see the **[TeachStack Product Website](https://ay2324s2-cs2103t-t09-1.github.io/tp/)**.
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
Binary file modified docs/images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d816339

Please sign in to comment.