From f4c27f732e03b436c8f18735e97119c8407eb511 Mon Sep 17 00:00:00 2001 From: jianminglok Date: Mon, 10 Apr 2023 20:25:31 +0800 Subject: [PATCH 1/2] Update README and AboutUs --- README.md | 22 ++++++++++++++++------ docs/AboutUs.md | 6 +++++- 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e37e110e1d4..f88f07e0c8c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ +# InternEase + +InternEase is a **powerful and innovative desktop app designed to streamline the internship application process primarily for Computer Science undergraduates**. With its optimized **combination of a Command Line Interface (CLI) and Graphical User Interface (GUI)**, InternEase offers users the best of both worlds - the speed and efficiency of a CLI for those who can type quickly, and the user-friendly experience of a GUI for those who prefer a visual interface. Whether you’re a seasoned CLI user or a first-time applicant new to work environment, InternEase makes it easy to keep track of your progress, deadlines, and follow-up actions, so you can focus on landing your dream internship. + [![CI Status](https://github.com/AY2223S2-CS2103T-W15-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S2-CS2103T-W15-4/tp/actions) +[![codecov](https://codecov.io/gh/AY2223S2-CS2103T-W15-4/tp/branch/master/graph/badge.svg?token=MVV9ABQAS8)](https://codecov.io/gh/AY2223S2-CS2103T-W15-4/tp) ![Ui](docs/images/Ui.png) -* This is **a software engineering project done by Team W15-4 from CS2103T(AY2223S2)**.
- The aim of this project is to: +## About the project + +* This is **a software engineering project done by Team W15-4 from CS2103T (AY2223S2)**.
+* The aim of this project is to: * help Computer Science students to keep track of their internship applications - * provide a flexible internship application management interface which includes CLI and GUI -* The project is based on an ongoing software project for a desktop application (called _AddressBook-Level3_) used for managing contact details by [SE-EDU initiative](https://se-education.org/addressbook-level3/). - * 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**. + * provide a flexible and efficient internship application management interface via **both CLI and GUI** * It is named `InternEase` because it eases the internship application management process via both well-implemented CLI and GUI to help users focus on their internship preparations. * For the detailed documentation of this project, see the **[InternEase Product Website](https://ay2223s2-cs2103t-w15-4.github.io/tp/)**. + +## Getting started +* View our [quick start guide](https://ay2223s2-cs2103t-w15-4.github.io/tp/UserGuide.html#quick-start) now to get started on an easier internship journey immediately. + +## Acknowledgements +* The project is based on an ongoing software project for a desktop application (called _AddressBook-Level3_) used for managing contact details by [SE-EDU initiative](https://se-education.org/addressbook-level3/). diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 63b53ba0d25..f836345aa78 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -56,4 +56,8 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` [[portfolio](team/jianminglok.md)] * Role: Developer -* Responsibilities: Add contact and edit status feature +* Responsibilities: + * Contact management features: `add_contact`, `edit_contact`, `delete_contact` + * Document management features: `add_docs`, `edit_docs`, `delete_docs` + * Edit internship application status feature: `edit_status` + * Archiving features: `archive`, `unarchive`, `list_archived` From 48322cff96ef5f2060babf4306d0593abb932112 Mon Sep 17 00:00:00 2001 From: jianminglok Date: Mon, 10 Apr 2023 20:26:33 +0800 Subject: [PATCH 2/2] Update index.md file --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index d8e0df64cc2..8d5e1023820 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ title: InternEase **InternEase is a desktop application for managing your internship applications.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface). * If you are interested in using InternEase, 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 about developing InternEase, the [**Developer Guide**](DeveloperGuide.html) is a good place to start. **Acknowledgements**