Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Branch readme features #57

Merged
merged 2 commits into from
Sep 30, 2020
Merged

Branch readme features #57

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb38d1e
Update README
andreatanky Sep 30, 2020
877b1c2
Update link
andreatanky Sep 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 24 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,32 @@
[![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/AY2021S1-CS2103T-F11-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-F11-3/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
## Project scope

* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing your academic tasks.
* 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` ...).
## Motivation

* 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#https://se-education.org/#contributing) for more info.

## Current features supported
* Importing timetable from NUSMods
* Adding assignments to ProductiveNUS
* Listing lessons and assignments
* Deleting assignments from ProductiveNUS
* Reminders for assignments


## Site Map
* [Developer Guide](https://ay2021s1-cs2103t-f11-3.github.io/tp/DeveloperGuide.html)

* [User Guide](https://ay2021s1-cs2103t-f11-3.github.io/tp/UserGuide.html)

* [About Us](https://ay2021s1-cs2103t-f11-3.github.io/tp/AboutUs.html)

## Acknowledgements

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