[kenzantonius] iP

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# duke.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.
 
@@ -13,7 +13,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    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:
+3. After that, locate the `src/main/java/duke.Duke.java` file, right-click it, and choose `Run duke.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
     ____        _        

build.gradle

@@ -0,0 +1,57 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'org.openjfx.javafxplugin' version '0.0.11'
+}
+
+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.Launcher"
+}
+
+shadowJar {
+    archiveBaseName = "duke"
+    archiveClassifier = null
+}
+
+run{
+    standardInput = System.in
+}

docs/README.md

@@ -1,29 +1,142 @@
 # User Guide
 
-## Features 
+Duke is a **desktop app for managing tasks, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Duke can get your tasks management done faster than traditional GUI apps.
 
-### Feature-ABC
+## Quick start
 
-Description of the feature.
+1. Ensure you have Java `11` or above installed in your Computer.
 
-### Feature-XYZ
+1. Download the latest `duke.jar` from [here](https://github.com/kenzantonius/ip/releases).
 
-Description of the feature.
+1. Copy the file to the folder you want to use as the _home folder_ for your Duke.
 
-## Usage
+1. Double click the jar file to run the application.<br>
+   A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
+   ![Ui](images/Ui.png)
 
-### `Keyword` - Describe action
+1. Type the command in the command box and press Enter to execute it.<br>
+   Some example commands you can try:
 
-Describe the action and its outcome.
+   * `list` : Lists all tasks.
 
-Example of usage: 
+   * `delete 3` : Deletes the 3rd task shown in the task list.
 
-`keyword (optional arguments)`
+   * `mark 3` : Mark the 3rd task shown in the task list.
 
-Expected outcome:
+   * `bye` : Exits the app.
 
-Description of the outcome.
+1. Refer to the [Features](#features) below for details of each command.
 
-```
-expected output
-```
+--------------------------------------------------------------------------------------------------------------------
+
+## Features
+
+### Adding a todo task: `todo`
+
+Adds a todo task to the task list.
+
+Format: `todo TASK_NAME`
+
+Examples:
+* `todo borrow book`
+
+### Adding a deadline task: `deadline`
+
+Adds a event task to the task list.
+
+Format: `deadline TASK_NAME /by DUE_DATE`
+
+Examples:
+* `deadline return book /by Sunday`
+
+### Adding a event task: `event`
+
+Adds a event task to the task list.
+
+Format: `event TASK_NAME /from START_DATE /to END_DATE`
+
+Examples:
+* `event project meeting /from Mon 2pm /to 4pm`
+
+### Mark a task : `mark`
+
+Marks the specified task from the task list.
+
+Format: `mark INDEX`
+
+* Deletes the task at the specified `INDEX`.
+* The index refers to the index number shown in the displayed task list.
+* The index **must be a positive integer** 1, 2, 3, …​
+
+Examples:
+* `mark 2` marks the 2nd task in the task list.
+
+### Unmark a task : `unmark`
+
+Unmarks the specified task from the task list.
+
+Format: `unmark INDEX`
+
+* Deletes the task at the specified `INDEX`.
+* The index refers to the index number shown in the displayed task list.
+* The index **must be a positive integer** 1, 2, 3, …​
+
+Examples:
+* `unmark 2` unmarks the 2nd task in the task list.
+
+### Listing all tasks : `list`
+
+Shows a list of all tasks in the task list.
+
+Format: `list`
+
+### Locating tasks by keyword: `find`
+
+Finds tasks whose tasks contain any of the given keywords.
+
+Format: `find KEYWORD`
+
+Examples:
+* `find John` returns tasks that have a keyword `John`
+
+### Deleting a task : `delete`
+
+Deletes the specified task from the task list.
+
+Format: `delete INDEX`
+
+* Deletes the task at the specified `INDEX`.
+* The index refers to the index number shown in the displayed task list.
+* The index **must be a positive integer** 1, 2, 3, …​
+
+Examples:
+* `delete 2` deletes the 2nd task in the task list.
+
+### Exiting the program : `bye`
+
+Exits the program.
+
+Format: `bye`
+
+### Saving the data
+
+Duke data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+
+### Editing the data file
+
+Duke data are saved as a txt file `[JAR file location]/data/duke.txt`. Advanced users are welcome to update data directly by editing that data file.
+
+<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
+If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run.
+</div>
+
+### Archiving data files `[coming in v2.0]`
+
+_Details coming soon ..._
+
+--------------------------------------------------------------------------------------------------------------------
+
+## FAQ
+
+**Q**: How do I transfer my data to another Computer?<br>
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Duke home folder.

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