[Daniel Ling Zhi Yuan] iP

README.md

@@ -1,24 +1,124 @@
-# Duke project template
-
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11, update Intellij to the most recent version.
-
-1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
-   1. Click `Open`.
-   1. Select the project directory, and click `OK`.
-   1. If there are any further prompts, accept the defaults.
-1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
-   In the same dialog, set the **Project language level** field to the `SDK default` option.
-3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+<div align= "center">
+  <h1 align= "center">BrotherBot</h1>
+
+
+> "We must live together as brothers or perish together like fools." - Martin Luther King Jr.
+> 
+![](docs/Ui.png)
+
+</div>
+
+## About The Project
+
+### Overview
+We all need a brother out there who's got our back all the time. Introducing BrotherBot, your one-stop task planner with a "Brother" personality.
+BrotherBot is designed to help you manage tasks with a unique 'bro' personality, ensuring that you stay on top of your responsibilities while feeling supported. This application transitions from traditional task management methods to a friendly, interactive approach.
+
+### Contributor(s)
+
+- [Daniel Ling](https://github.com/danilingzy)
+
+### Built With
+
+This section lists major libraries used.
+
+* [JavaFX](https://openjfx.io/)
+* [JUnit](https://junit.org/junit5/)
+
+
+## Features
+
+<div align= "left">
+
+- [X] Tracks tasks
+- [ ] Eat supper with you *(coming soon)*
+
+ </div>
+
+ ***
+### Adding Tasks
+1. #### Add ToDo Tasks: ```todo```
+   Add a ToDo task that you need to complete using the ```todo``` keyword.
+   Example: ```todo run``` will add "run" to your list of tasks.
+
+2. #### Add Deadline Tasks: ```deadline```
+   Add a Deadline Task that you have to complete by a certain deadline using the ```deadline``` keyword.  
+   Deadline will be entered behind a slash, with the format of ***'dd/MM/yyyy HHmm'***.
+   Example: ```deadline project /by 23/02/2023 1400``` will add "project" to your list of tasks.
+
+3. #### Add Event Tasks: ```event```
+   Add an Event that you have to attend using the ```event``` keyword.  
+   Duration of the event will be entered with behind a slash, with the first slash representing the start of the event and the second slash representing the end of the event.  
+   Example: ```event CS2103T Lecture /from 17/01/2023 1400 /to 17/01/2023 1600``` will add "CS2103T Lecture" to your list of tasks.
+
+***
+
+### Deleting Tasks: ```delete```
+
+Delete a task in the task list using the ```delete``` keyword.  
+A positive integer (i.e., 1, 2, 3...) must be specified behind the keyword, and the task to be deleted should exist.
+Example: ```delete 2``` will delete the second item in the list.
+
+***
+
+### Exiting the Application: ```bye```
+
+Simply by using the keyword ```bye```, the program will exit on its own.
+Example: ```bye``` will exit the program.
+
+***
+
+### Finding Tasks: ```find```
+
+Find a task in the list using the ```find``` keyword.  
+The task you are looking for should be entered behind the keyword.
+Example: ```find project``` will list out all the tasks that contain the word 'project'.
+
+***
+
+### Displaying Tasks: ```display```
+
+List out all the tasks using the ```display``` keyword.
+Example: ```display``` will list out all the tasks that exist.
+
+***
+
+### Marking Tasks: ```mark```
+
+Mark a task that has been completed using the ```mark``` keyword.   
+A positive integer (i.e., 1, 2, 3...) should be specified behind the keyword.
+Example: ```mark 3``` will mark the third task on the list.
+
+***
+
+### Finding Freeslot: ```free```
+
+Find the next free slot using the ```free``` keyword.  
+A valid duration of format ***'xHyyM'*** where x is the number of hours, and yy is the number of minutes, should be entered behind the keyword.
+Example: ```free 2H30M``` will return your next free 2 hour 30 minute time slot.
+
+## Getting Started
+
+Bro! It is:
+
+- ~~Hard~~ Easy to use
+- *Friendly*
+- Treats u like a real **bro** :star_struck:
+
+### Wanna gain a real bro?
+
+Download it [here](https://github.com/daniellingzy/ip/releases/tag/v0.2)
+
+Here’s the `Launcher` class:
+```java
+package brotherbot;
+
+import javafx.application.Application;
+
+public class Launcher {
+    public static void main(String[] args) {
+        Application.launch(BrotherBot.class, args);
+    }
+}
+```
+

build.gradle

@@ -0,0 +1,62 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+}
+
+repositories {
+    gradlePluginPortal()
+    mavenCentral()
+}
+
+dependencies {
+    String javaFxVersion = '11'
+
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
+    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+}
+
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+        showStandardStreams = false
+    }
+}
+
+application {
+    mainClassName = "brotherbot.Launcher"
+}
+
+shadowJar {
+    archiveBaseName = "Launcher"
+    archiveClassifier = null
+}
+
+run {
+    standardInput = System.in
+    enableAssertions = true
+}
+
+run {
+
+}

docs/README_old.md

@@ -0,0 +1,141 @@
+# BrotherBot
+
+> "We must live together as brothers or perish together like fools." - Martin Luther King Jr.
+
+We all need a brother out there who's got our back all the time. Introducing BrotherBot, your one-stop task planner with a "Brother" personality.
+
+Bro! It is:
+
+- ~~Hard~~ Easy to use
+- *Friendly*
+- Treats u like a real **bro** :star_struck:
+
+## Wanna gain a real bro?
+
+1. Download it [here](https://github.com/daniellingzy/ip/releases/tag/v0.2)
+
+## Bro features
+
+
+- [X] Tracks tasks
+- [ ] Eat supper with you *(coming soon)*
+
+If you are a Java programmer, you can review the code easily with its well designed code and JavaDocs. Here's the `Launcher` class:
+```
+package brotherbot;
+
+import javafx.application.Application;
+
+public class Launcher {
+    public static void main(String[] args) {
+        Application.launch(BrotherBot.class, args);
+    }
+}
+```
+
+   ```
+   Adapted from
+    ____        _        
+   |  _ \ _   _| | _____ 
+   | | | | | | | |/ / _ \
+   | |_| | |_| |   <  __/
+   |____/ \__,_|_|\_\___|
+   ```
+
+
+
+
+# User Guide
+
+
+## **Welcome to _BrotherBot_.**
+BrotherBot is an application used to manage your tasks with a unique 'bro' personality!
+
+## Feature Summary
+- [Adding Tasks](https://github.com/daniellingzy/ip/edit/master/docs/README.md#adding-tasks)
+    - ToDo Tasks: ```todo```
+    - Deadline Tasks: ```deadline```
+    - Event Tasks: ```event```
+- [Deleting Tasks](https://github.com/daniellingzy/ip/edit/master/docs/README.md#deleting-tasks-delete): ```delete```
+- [Exiting Program](https://github.com/daniellingzy/ip/edit/master/docs/README.md#exiting-the-application-bye): ```bye```
+- [Finding Tasks](https://github.com/daniellingzy/ip/edit/master/docs/README.md#finding-tasks-find): ```find```
+- [Displaying Tasks](https://github.com/daniellingzy/ip/edit/master/docs/README.md#displaying-tasks-display): ```display```
+- [Marking Tasks](https://github.com/daniellingzy/ip/edit/master/docs/README.md#marking-tasks-mark): ```mark```
+- [Finding Freeslot](https://github.com/daniellingzy/ip/edit/master/docs/README.md#finding-freeslot): ```free```
+
+## Features
+
+### Adding Tasks
+1.  #### Add ToDo Tasks: ```todo```
+Add a ToDo task that you have to complete using the ```todo``` keyword.
+
+Example: ```todo run``` will add run to your list of tasks
+
+2. #### Add Deadline Tasks: ```deadline```
+Add a Deadline Task that you have to complete by a certain deadline using the ```deadline``` keyword.  
+Deadline will be entered behind a slash, with the format of ***'dd/MM/yyyy HHmm'***.
+
+Example: ```deadline project /by 23/02/2023 1400``` will add project to your list of tasks
+
+3. #### Add Event Tasks: ```event```
+Add an Event that you have to attend using the ```event``` keyword.  
+Duration of the event will be entered with behind a slash, with the first slash representing the start of the event and the second slash representing the end of the event.  
+Duration format for the start and end of the event will follow ***'dd/MM/yyyy HHmm'***.
+
+Example: ```event CS2103T Lecture /from 17/01/2023 1400 /to 17/01/2023 1600``` will add CS2103T Lecture to your list of tasks
+
+***  
+
+### Deleting Tasks: ```delete```
+
+Delete a task in the tasklist using the ```delete``` keyword.  
+A positive integer (ie. 1, 2, 3...) must be specified behind the keyword and the task to be deleted should exist.
+
+Example: ```delete 2``` will delete the second item in the list
+
+***    
+
+### Exiting the Application: ```bye```
+
+Simply by using the keyword ```bye```, the program will exit on its own.
+
+Example: ```bye``` will exit the program
+
+***
+
+### Finding Tasks: ```find```
+
+Find a task in the list using the ```find``` keyword.  
+The task you are looking for should be entered behind the keyword.
+
+Example: ```find project``` will list out all the tasks that contains the word 'project'
+
+***
+
+### Displaying Tasks: ```display```
+
+List out all the tasks using the ```display``` keyword.
+
+Example: ```display``` will list out all the tasks that exist
+
+***  
+
+### Marking Tasks: ```mark```
+
+Mark a task that has been completed using the ```mark``` keyword.   
+A positive integer (ie 1, 2, 3...) should be specified behind the keyword.
+
+Note: Task to be marked should exist and should not already be marked.
+
+Example: ```mark 3``` will mark the third task on the list
+
+
+***
+
+### Finding Freeslot: ```free```
+
+Find the next freeslot using the ```free``` keyword.
+A valid duration of format ***'xHyyM'*** where x is the number of hours, and  yy is the number of minutes,
+should be entered behind the keyword.
+
+Example: ```free 2H30M``` will return your next free 2 hour 30 minute timeslot.

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.2-all.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists