Skip to content

Commit

Permalink
Merge pull request #66 from dwsc37/update-readme-page
Browse files Browse the repository at this point in the history
docs: Update landing pages
  • Loading branch information
dwsc37 authored Sep 29, 2024
2 parents e1b9481 + cac8bf7 commit 7486192
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 19 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-T08-2/tp/actions)
[![CI Status](https://github.com/AY2425S1-CS2103T-T08-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-T08-2/tp/actions)
[![codecov](https://codecov.io/gh/AY2425S1-CS2103T-T08-2/tp/graph/badge.svg?token=BDD7P3MXJN)](https://codecov.io/gh/AY2425S1-CS2103T-T08-2/tp)
# KeyContacts

![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.
* This is **brownfield team project for Software Engineering (SE) students from the National University of Singapore**.<br>
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
* It is written in **OOP Fashion**.
* It now functions as a tool for home piano tutors to manage their students' information.
* It is named `KeyContacts`.
* For the detailed documentation of this project, see the **[KeyContacts Website](https://ay2425s1-cs2103t-t08-2.github.io/tp/)**
2 changes: 1 addition & 1 deletion docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<li><a href="{{baseUrl}}/UserGuide.html" class="nav-link">User Guide</a></li>
<li><a href="{{baseUrl}}/DeveloperGuide.html" class="nav-link">Developer Guide</a></li>
<li><a href="{{baseUrl}}/AboutUs.html" class="nav-link">About Us</a></li>
<li><a href="https://github.com/se-edu/addressbook-level3" target="_blank" class="nav-link"><md>:fab-github:</md></a>
<li><a href="https://github.com/AY2425S1-CS2103T-T08-2/tp" target="_blank" class="nav-link"><md>:fab-github:</md></a>
</li>
<li slot="right">
<form class="navbar-form">
Expand Down
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.
15 changes: 8 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,20 @@
title: ""
---

# AddressBook Level-3

[![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)
# Key Contacts
[![CI Status](https://github.com/AY2425S1-CS2103T-T08-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-T08-2/tp/actions)
[![codecov](https://codecov.io/gh/AY2425S1-CS2103T-T08-2/tp/graph/badge.svg?token=BDD7P3MXJN)](https://codecov.io/gh/AY2425S1-CS2103T-T08-2/tp)

![Ui](images/Ui.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).
**KeyContacts is a desktop application for home piano tutors to manager their students' information.**
While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
* If you are interested in using KeyContacts, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing KeyContacts, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.


**Acknowledgements**

* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

0 comments on commit 7486192

Please sign in to comment.