Merge pull request #23 from modembcc/branch-update-readme

Update the README and project website

README.md

@@ -1,15 +1,29 @@
-[![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/AY2324S2-CS2103T-W08-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W08-4/tp/actions)
 [![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W08-4/tp/graph/badge.svg?token=JRBJM9DOXE)](https://codecov.io/gh/AY2324S2-CS2103T-W08-4/tp)
 
+<div align="center">
+    <h3 align="center">DevPlan Pro</h3>
+    <p align="center">
+        Keep track of your projects in a single app
+        <br/>
+        <a href="https://github.com/othneildrew/Best-README-Template">Project Website</a>
+        ·
+        <a href="https://github.com/othneildrew/Best-README-Template/issues">Planned Features</a>
+    </p>
+</div>
+
 ![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#https://se-education.org/#contributing) for more info.
+### About The Project
+
+**Devplan Pro** is a project management app that is catered towards project managers who love typing. It allows the user to keep track of their various projects, the ongoing tasks within the projects, and people who are responsible for those tasks. Every action is executed through the input box using an intuitive [list of commands](https://github.com/othneildrew/Best-README-Template). Download now get a boost to your productivity.
+
+### Installation
+
+- Still in development
+
+### Acknowledgement
+
+- This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+- This README is based on the [Best-README-Template](https://github.com/othneildrew/Best-README-Template) template.
+- Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)

docs/_config.yml

@@ -1,4 +1,4 @@
-title: "AB-3"
+title: "DevPlan Pro"
 theme: minima
 
 header_pages:
@@ -8,7 +8,7 @@ header_pages:
 
 markdown: kramdown
 
-repository: "se-edu/addressbook-level3"
+repository: "AY2324S2-CS2103T-W08-4/tp"
 github_icon: "images/github-icon.png"
 
 plugins:

docs/_sass/minima/_base.scss

@@ -5,43 +5,62 @@ html {
 /**
  * Reset some basic elements
  */
-body, h1, h2, h3, h4, h5, h6,
-p, blockquote, pre, hr,
-dl, dd, ol, ul, figure {
+body,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+p,
+blockquote,
+pre,
+hr,
+dl,
+dd,
+ol,
+ul,
+figure {
   margin: 0;
   padding: 0;
-
 }
 
-
-
 /**
  * Basic styling
  */
 body {
-  font: $base-font-weight #{$base-font-size}/#{$base-line-height} $base-font-family;
+  font: $base-font-weight #{$base-font-size}/#{$base-line-height}
+    $base-font-family;
   color: $text-color;
   background-color: $background-color;
   -webkit-text-size-adjust: 100%;
   -webkit-font-feature-settings: "kern" 1;
-     -moz-font-feature-settings: "kern" 1;
-       -o-font-feature-settings: "kern" 1;
-          font-feature-settings: "kern" 1;
+  -moz-font-feature-settings: "kern" 1;
+  -o-font-feature-settings: "kern" 1;
+  font-feature-settings: "kern" 1;
   font-kerning: normal;
   display: flex;
   min-height: 100vh;
   flex-direction: column;
   overflow-wrap: break-word;
 }
 
-
-
 /**
  * Set `margin-bottom` to maintain vertical rhythm
  */
-h1, h2, h3, h4, h5, h6,
-p, blockquote, pre,
-ul, ol, dl, figure,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+p,
+blockquote,
+pre,
+ul,
+ol,
+dl,
+figure,
 %vertical-rhythm {
   margin-bottom: $spacing-unit / 2;
 }
@@ -58,8 +77,6 @@ main {
   display: block; /* Default value of `display` of `main` element is 'inline' in IE 11. */
 }
 
-
-
 /**
  * Images
  */
@@ -68,8 +85,6 @@ img {
   vertical-align: middle;
 }
 
-
-
 /**
  * Figures
  */
@@ -81,12 +96,11 @@ figcaption {
   font-size: $small-font-size;
 }
 
-
-
 /**
  * Lists
  */
-ul, ol {
+ul,
+ol {
   margin-left: $spacing-unit;
 }
 
@@ -97,17 +111,18 @@ li {
   }
 }
 
-
-
 /**
  * Headings
  */
-h1, h2, h3, h4, h5, h6 {
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
   font-weight: $base-font-weight;
 }
 
-
-
 /**
  * Links
  */
@@ -133,7 +148,6 @@ a {
   }
 }
 
-
 /**
  * Blockquotes
  */
@@ -148,13 +162,12 @@ blockquote {
     margin-bottom: 0;
   }
 
-  i, em {
+  i,
+  em {
     font-style: normal;
   }
 }
 
-
-
 /**
  * Code formatting
  */
@@ -192,8 +205,6 @@ pre {
   }
 }
 
-
-
 /**
  * Wrapper
  */
@@ -212,8 +223,6 @@ pre {
   }
 }
 
-
-
 /**
  * Clearfix
  */
@@ -223,8 +232,6 @@ pre {
   clear: both;
 }
 
-
-
 /**
  * Icons
  */
@@ -252,7 +259,8 @@ table {
       background-color: $table-zebra-color;
     }
   }
-  th, td {
+  th,
+  td {
     padding: ($spacing-unit / 3) ($spacing-unit / 2);
   }
   th {
@@ -267,7 +275,7 @@ table {
     display: block;
     overflow-x: auto;
     -webkit-overflow-scrolling: touch;
-            -ms-overflow-style: -ms-autohiding-scrollbar;
+    -ms-overflow-style: -ms-autohiding-scrollbar;
   }
 }
 
@@ -288,8 +296,7 @@ table {
     text-align: center;
   }
   .site-header:before {
-    content: "AB-3";
+    content: "DevPlan Pro";
     font-size: 32px;
   }
 }
-

docs/index.md

@@ -1,19 +1,18 @@
 ---
 layout: page
-title: AddressBook Level-3
+title: DevPlan Pro
 ---
 
-[![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)
+[![CI Status](https://github.com/AY2324S2-CS2103T-W08-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W08-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W08-4/tp/graph/badge.svg?token=JRBJM9DOXE)](https://codecov.io/gh/AY2324S2-CS2103T-W08-4/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).
-
-* 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.
+**Devplan Pro** is a project management app that is catered towards project managers who love typing. It allows the user to keep track of their various projects, the ongoing tasks within the projects, and people who are responsible for those tasks. Every action is executed through the input box using an intuitive [list of commands](https://github.com/othneildrew/Best-README-Template).
 
+- If you are interested in using DevPlan Pro, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
+- If you are interested about developing DevPlan Pro, 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)
+- Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)