[Brian Chow] iP

README.md

@@ -1,19 +1,43 @@
-# Duke project template
+# Duke
 
-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.
+Duke is a interactive chatbot with UI. 
+> "Your mind is for having ideas, not holding them" - David Allen
 
-## Setting up in Intellij
+Duke is a task tracker that can track three categories of tasks:
+- Todo
+- Deadline
+- Event
 
-Prerequisites: JDK 11, update Intellij to the most recent version.
+## Setting up
 
-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:
+Setting up Duke is extremely easy. All you need to do is:
+1) Download JDK 11 and above from [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk)
+2) Download the latest JAR file release from the right side of this repository
+3) Run the command java -jar ip.jar
+
+It's that simple! :)
+
+## Commands
+There are a few commands you can run in Duke. These include:
+- [x] todo
+- [X] deadline
+- [X] event
+- [X] delete
+- [X] list
+- [X] find
+- [X] bye
+
+## Using an IDE
+You can further edit/modify Duke by navigating to the `src` folder which contains all the `java` files
+
+You can run it from Launcher.java by using __main__:
+<pre>
+public class Launcher {
+    <b>public static void main(String[] args)</b> {
+        Application.launch(Main.class,args);
+    }
+}
+</pre>
    ```
    Hello from
     ____        _        

build.gradle

@@ -0,0 +1,61 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    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'
+    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'
+}
+
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+        showStandardStreams = false
+    }
+}
+
+application {
+    mainClassName = "duke.Duke"
+}
+
+shadowJar {
+    archiveBaseName = "duke"
+    archiveClassifier = null
+}
+
+checkstyle {
+    toolVersion = '8.29'
+}
+
+run{
+    standardInput = System.in
+    enableAssertions = true;
+}

docs/README.md

@@ -1,29 +1,135 @@
 # User Guide
+Duke is a interactive chatbot with UI.
+> “Software and cathedrals are much the same; first we build them, then we pray.”
+
+Duke is a task tracker that can track three categories of tasks:
+- Todo
+- Deadline
+- Event
 
 ## Features 
+1. `todo`
+2. `deadline`
+3. `event`
+4. `list`
+5. `delete`
+6. `mark`
+7. `unmark`
+8. `snooze`
+9. `bye`
 
-### Feature-ABC
+## Usage
 
-Description of the feature.
+## `todo NAME` - creates a Todo task with name NAME
 
-### Feature-XYZ
+Example of usage: 
 
-Description of the feature.
+`todo work`
 
-## Usage
+Expected outcome:
 
-### `Keyword` - Describe action
+Expected outcome:
+Creates a new Todo object called work
+*Take note of the space between todo and NAME!
 
-Describe the action and its outcome.
 
-Example of usage: 
+## `deadline NAME /by DATE TIME(optional)` - creates a Deadline task with name NAME at DATE and TIME
+
+Example of usage:
+```
+deadline report submission /by 2022-02-14 23:59
+deadline report submission /by 2022-02-14
+```
+
+Expected outcome:
+Creates a new Deadline object with DATE and TIME(optional)
+*Format of date: yyyy-mm-dd
+*Format of time: hh:mm
+
+
+## `event NAME /at DATE TIME(optional)` - creates a Event task with name NAME at DATE and TIME
+
+Example of usage:
+```
+event meeting /at 2022-02-12 01:00
+event meeting /at 2022-02-12
+```
+
+Expected outcome:
+Creates a new Event object with DATE and TIME(optional)
+*Format of date: yyyy-mm-dd
+*Format of time: hh:mm
+
+
+## `list` - lists out all tasks
+
+Example of usage:
+```
+list
+```
+
+Expected outcome:
+A list of all tasks in their respective formats
+
+
+## `delete INDEX` - deletes task at specific INDEX
 
-`keyword (optional arguments)`
+Example of usage:
+```
+delete 1
+```
+
+Expected outcome:
+Delete task from tasklist and prints the deleted task
+*Recommended to use alongside `list` command so that you get the right index
+*Important to delete a valid index - Do not go out of bounds!
+
+
+## `mark INDEX` - marks task as done
+
+Example of usage:
+```
+mark 0
+```
+
+Expected outcome:
+Marks task and prints the marked task
+*Recommended to use alongside `list` command so that you get the right index
+
+
+## `unmark INDEX` - marks task as undone
+
+Example of usage:
+```
+unmark 0
+```
+
+Expected outcome:
+Marks task and prints the marked task
+*Recommended to use alongisde `list` command so that you get the right index
+
+
+## `snooze NAME DATE /t NEWDATE NEWTIME` - changes the date & time of task
+
+Example of usage:
+```
+snooze meeting 2022-02-12 /t 2022-03-20 23:59
+```
 
 Expected outcome:
+Sets new task date and time and prints new date and time for task
+
+_ _Keeping track of the exact time is difficult_ _, which is why all you need to input is the date of the task and not the time.
+*Getting the exact name and date of the task is important
+
 
-Description of the outcome.
+## `bye` - ends the program
 
+Example of usage:
 ```
-expected output
+bye
 ```
+
+Expected outcome:
+Duke sends a goodbye message and exits the program, closing the UI
+

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-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists