[izruff] iP

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/data/

build.gradle

@@ -0,0 +1,61 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
+    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
+
+    String javaFxVersion = '17.0.7'
+
+    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 {
+    mainClass.set("mittens.Mittens")
+}
+
+checkstyle {
+    toolVersion = '10.2'
+}
+
+shadowJar {
+    archiveBaseName = "mittens"
+    archiveClassifier = null
+}
+
+run{
+    standardInput = System.in
+}

docs/README.md

@@ -1,30 +1,75 @@
-# Duke User Guide
+# Mittens: User Guide
 
-// Update the title above to match the actual product name
+![Screenshot of the UI](/Ui.png)
 
-// Product screenshot goes here
+_Mittens_ is a desktop app for managing tasks, optimized for use via a Command Line Interface (CLI). Get through your day with the cute cat _Mittens_ and doing tasks will feel like a breeze!
 
-// Product intro goes here
+## Quick start
 
-## Adding deadlines
+1. Ensure you have Java `17` installed in your computer.
+2. Download the latest `mittens.jar` from [here](izruff.github.io/ip/releases).
+3. Open your Mittens app for the first time by running `java -jar mittens.jar` on your command line. A folder named `data` will be created, which Mittens will use to save your task list.
+4. Try typing some commands into the input box and hit Enter or the Send button to see Mittens in action! Here are some commands to get you started:
+> - `list`: lists all stored tasks
+> - `todo Read book`: adds a todo task named "Read book"
+> - `deadline Submit work \by 2024-09-30`: adds a deadline task named "Submit work" with a deadline of September 30th
+> - `mark 1`: marks the first task in the list as done
+> - `bye`: exits the app
 
-// Describe the action and its outcome.
+## Adding tasks: `todo`, `deadline`, `event`
 
-// Give examples of usage
+There are three types of tasks you can add:
 
-Example: `keyword (optional arguments)`
+- `todo`: A simple task with a description, no dates or times.
+- `deadline`: A task with a description and the deadline date.
+- `event`: A task with a description and a date range of when the event is happening.
 
-// A description of the expected outcome goes here
+Format:
 
-```
-expected output
-```
+- `todo <description>`
+- `deadline <description> \by <date>`
+- `event <description> \from <start-date> \to <end-date>`
 
-## Feature ABC
+Example:
 
-// Feature details
+- `todo Read book`
+- `deadline Submit work \by 2024-09-30`
+- `event Meeting \from 2024-09-30 \to 2024-10-01`
 
+## List tasks: `list`
 
-## Feature XYZ
+You can list all tasks you have stored in Mittens by typing `list`.
 
-// Feature details
+Each task is displayed in the following format:
+> `[<task-type>][<done-status>] <description>`
+
+For example, a done deadline task will be displayed as:
+> `[D][X] Submit work (due Sep 30 2024)`
+
+Format: `list`
+
+## Mark tasks as done or not done: `mark`, `unmark`
+
+You can mark a certain task as done or not done using `mark` and `unmark`.
+
+Format:
+- `mark <task-number>`
+- `unmark <task-number>`
+
+## Delete tasks: `delete`
+
+You can delete a certain task using `delete`.
+
+Format: `delete <task-number>`
+
+## Find tasks: `find`
+
+You can find tasks that contain a certain keyword using `find`.
+
+Format: `find <keyword>`
+
+## Exit the app: `bye`
+
+You can exit the app by typing `bye`. Or, you can just exit through the window's close button.
+
+Format: `bye`

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists