Migrate Docs to Markbind

README.md

@@ -1,14 +1,12 @@
-[![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/AY2324S1-CS2103T-T15-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T15-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-T15-4/tp/graph/badge.svg)](https://codecov.io/gh/AY2324S1-CS2103T-T15-4/tp)
 
 ![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.
+* This is our **team project** for the course **CS2103T** in AY2023/2024 Semester 1.
+* This is based on the `AddressBook-Level3` project created by the [SE-EDU initiative](https://se-education.org).
+* The project is a desktop application, designed as a networking platform to help professionals efficiently manage their connections and enhance their networking experiences.
+  * It is **written in OOP fashion**.
   * 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#https://se-education.org/#contributing) for more info.
+* It is named `Connectify`.
+* For the detailed documentation of this project, see the **[Connectify Product Website](https://ay2324s1-cs2103t-t15-4.github.io/tp/)**

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'connectify.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'connectify.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -11,51 +11,49 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Lim Wei Hern
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nrehiew.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/nrehiew)]
+[[portfolio](team/nrehiew.md)]
 
-* Role: Project Advisor
+* Role: Integration
 
-### Jane Doe
+### Peng Victor M X
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/victorpengmx.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/victorpengmx)]
+[[portfolio](team/victorpengmx.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
 
-### Johnny Doe
+### Gerald Ng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/geraldngjx.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/geraldngjx)]
+[[portfolio](team/geraldngjx.md)]
 
 * Role: Developer
-* Responsibilities: Data
 
-### Jean Doe
+### Ryan Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ryantzr1.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/ryantzr1)]
+[[portfolio](team/ryantzr1.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Product
+* Responsibilities: In charge of UX and product functionality
 
-### James Doe
+### Ian Tay
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tayian.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tayian)]
+[[portfolio](team/tayian.md)]
 
 * Role: Developer
 * Responsibilities: UI

docs/SettingUp.md

@@ -28,7 +28,7 @@ If you plan to use Intellij IDEA (highly recommended):
    Note: Importing a Gradle project is slightly different from importing a normal Java project.
    </box>
 1. **Verify the setup**:
-   1. Run the `seedu.address.Main` and try a few commands.
+   1. Run the `connectify.Main` and try a few commands.
    1. [Run the tests](Testing.md) to ensure they all pass.
 
 --------------------------------------------------------------------------------------------------------------------

docs/Testing.md

@@ -36,6 +36,6 @@ This project has three types of tests:
 1. *Unit tests* targeting the lowest level methods/classes.<br>
    e.g. `seedu.address.commons.StringUtilTest`
 1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).<br>
-   e.g. `seedu.address.storage.StorageManagerTest`
+   e.g. `storage.connectify.StorageManagerTest`
 1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.<br>
-   e.g. `seedu.address.logic.LogicManagerTest`
+   e.g. `logic.connectify.LogicManagerTest`