[Johannes] iP

.gitignore

@@ -14,4 +14,7 @@ src/main/resources/docs/
 bin/
 
 /text-ui-test/ACTUAL.txt
-text-ui-test/EXPECTED-UNIX.TXT
+/text-ui-test/EXPECTED-UNIX.TXT
+storage.txt
+
+/docs/*.html

README.md

@@ -1,19 +1,14 @@
-# Duke project template
+# Duke, your Personal Task List Manager
 
-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 here to organise and **carry** you through your work life!
 
-## Setting up in Intellij
+## Using Duke
 
-Prerequisites: JDK 11, update Intellij to the most recent version.
+1. Download Duke jar file.
+2. Just *Double-Click* it!
+
+### Guide to using Duke
 
-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
     ____        _        
@@ -22,3 +17,47 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    | |_| | |_| |   <  __/
    |____/ \__,_|_|\_\___|
    ```
+
+Some inputs you can use to start using Duke:
+
+```
+todo <Todo task> //adds a Todo task into your task list.
+deadline <Deadline task> <yyyy-MM-dd HH:mm> //adds a Deadline task into your task list.
+event <Event task> <yyyy-MM-dd HH:mm HH:mm> //adds an Event task into your task list.
+
+mark <Task number> //marks the n<</sup> item in the task list as done.
+unmark <Task number> //marks the n<sup>th</sup> item in the task list as not done.
+find <Task> //finds the task with that description from the task list.
+remove <Task number> //removes the n<sup>th</sup> item in the task list.
+
+```
+### Start of using application.
+
+![welcomeDuke](https://user-images.githubusercontent.com/89232083/190049715-b3ade24c-2630-4002-bad0-945560f32e7a.png)
+
+This is the welcome page when you first launch the application. To start adding tasks, just input your command in the text box and press the `Enter` key or click the `Enter` button right beside the text box.
+
+![Screenshot (124)](https://user-images.githubusercontent.com/89232083/190051826-8a724486-c0b4-41bb-9f1e-23fb85166797.jpg) ![Screenshot (126)](https://user-images.githubusercontent.com/89232083/190051850-c214ef40-95fe-4aa1-a29d-1180b582f4ae.png)
+
+You can do the same steps with the rest of the commands listed [here].(https://github.com/jwdavis0200/ip_own/edit/master/README.md#guide-to-using-duke)
+
+### Terminating the program
+
+To stop using the app, just send bye to Duke and the application will close.
+Your tasks will be saved in the application data for you to continue using the next time you start Duke!
+
+### For Pro-users
+If you want to use your own set of data, you can do so by replacing the storage.txt file with your own txt file with the same name.
+
+**Please** make sure you use the same format as Duke to allow for successful reading of the app data.
+
+```
+
+[T][X] read book
+[D][ ] assignment  (by: 2022-07-08 08:30)
+[E][X] project meeting  (at: 2022-08-08 12:30 to 2022-08-08 13:30)
+
+```
+
+Have fun using Duke V2, more features will be coming to you!
+

build.gradle

@@ -0,0 +1,74 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'checkstyle'
+
+}
+checkstyle {
+    toolVersion= '10.2'
+}
+
+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 = "dukechatbot.duke.Launcher"
+}
+
+shadowJar {
+    archiveBaseName = "DukeTaskBot"
+    archiveClassifier = null
+}
+
+run{
+    standardInput = System.in
+}
+
+jar {
+    manifest {
+        attributes "Main-Class" : "dukechatbot.duke.Launcher"
+    }
+}
+task customFatJar(type: Jar) {
+    manifest.from jar.manifest
+    from {
+        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+    }
+    baseName  'DukeChatbot'
+    with jar
+
+}

docs/README.md

@@ -1,29 +1,63 @@
-# User Guide
+# Duke, your Personal Task List Manager
 
-## Features 
+Duke is here to organise and **carry** you through your work life!
 
-### Feature-ABC
+## Using Duke
 
-Description of the feature.
+1. Download Duke jar file.
+2. Just *Double-Click* it!
 
-### Feature-XYZ
+### Guide to using Duke
 
-Description of the feature.
+   ```
+   Hello from
+    ____        _        
+   |  _ \ _   _| | _____ 
+   | | | | | | | |/ / _ \
+   | |_| | |_| |   <  __/
+   |____/ \__,_|_|\_\___|
+   ```
 
-## Usage
+Some inputs you can use to start using Duke:
 
-### `Keyword` - Describe action
+```
+todo <Todo task> //adds a Todo task into your task list.
+deadline <Deadline task> <yyyy-MM-dd HH:mm> //adds a Deadline task into your task list.
+event <Event task> <yyyy-MM-dd HH:mm HH:mm> //adds an Event task into your task list.
+
+mark <Task number> //marks the n<</sup> item in the task list as done.
+unmark <Task number> //marks the n<sup>th</sup> item in the task list as not done.
+find <Task> //finds the task with that description from the task list.
+remove <Task number> //removes the n<sup>th</sup> item in the task list.
+
+```
+### Start of using application.
+
+![welcomeDuke](https://user-images.githubusercontent.com/89232083/190049715-b3ade24c-2630-4002-bad0-945560f32e7a.png)
+
+This is the welcome page when you first launch the application. To start adding tasks, just input your command in the text box and press the `Enter` key or click the `Enter` button right beside the text box.
 
-Describe the action and its outcome.
+![Screenshot (124)](https://user-images.githubusercontent.com/89232083/190051826-8a724486-c0b4-41bb-9f1e-23fb85166797.jpg) ![Screenshot (126)](https://user-images.githubusercontent.com/89232083/190051850-c214ef40-95fe-4aa1-a29d-1180b582f4ae.png)
 
-Example of usage: 
+You can do the same steps with the rest of the commands listed [here].(https://github.com/jwdavis0200/ip_own/edit/master/README.md#guide-to-using-duke)
 
-`keyword (optional arguments)`
+### Terminating the program
 
-Expected outcome:
+To stop using the app, just send bye to Duke and the application will close.
+Your tasks will be saved in the application data for you to continue using the next time you start Duke!
 
-Description of the outcome.
+### For Pro-users
+If you want to use your own set of data, you can do so by replacing the storage.txt file with your own txt file with the same name.
+
+**Please** make sure you use the same format as Duke to allow for successful reading of the app data.
 
 ```
-expected output
+
+[T][X] read book
+[D][ ] assignment  (by: 2022-07-08 08:30)
+[E][X] project meeting  (at: 2022-08-08 12:30 to 2022-08-08 13:30)
+
 ```
+
+Have fun using Duke V2, more features will be coming to you!
+