[Lim Yong En Dominic] iP

.config/checkstyle/suppressions.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+    "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+    "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+  <suppress checks="JavadocType" files=".*Test\.java"/>
+  <suppress checks="MissingJavadocMethodCheck" files=".*Test\.java"/>
+</suppressions>

build.gradle

@@ -0,0 +1,62 @@
+plugins {
+    id 'checkstyle'
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
+}
+
+checkstyle {
+    toolVersion = '10.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 {
+    mainClassName = "zoe.Launcher"
+}
+
+shadowJar {
+    archiveBaseName = "zoe"
+    archiveClassifier = null
+    dependsOn("distZip", "distTar")
+}
+
+run{
+    standardInput = System.in
+}
+

data/SavedTasks.txt

@@ -0,0 +1,7 @@
+todo_read book_1
+event_meeting /from 2pm/to 6pm_1
+deadline_english project/by 2024-03-01 23:58_0
+deadline_math project/by 2024-03-01 23:59_0
+deadline_art project/by 2024-05-03 23:58_0
+deadline_science project/by 2024-05-03 23:59_0
+EOF

docs/README.md

@@ -1,29 +1,76 @@
-# User Guide
+# Zoe User Guide
 
-## Features 
+![Zoe Ui](https://arixeyeion.github.io/ip/Ui.png)
 
-### Feature-ABC
+Hey you! Yes you! Do you need to manage tasks? Well I can do it for you!
 
-Description of the feature.
+## Get Started
 
-### Feature-XYZ
+1. Ensure you have java 11 installed in your computer
+2. Download the latest Zoe.jar from [here](https://github.com/Arixeyeion/ip/releases/tag/A-Release)
+3. Copy the jar file to a directory of your choosing
+4. Open the command terminal, change to the directory you chose in step 3 and key in `java -jar Zoe.jar`
+5. aaaaaaaaaaaaand Viola! you can start managing your tasks
 
-Description of the feature.
+## Features
 
-## Usage
+### Add ToDos
 
-### `Keyword` - Describe action
+Adds a new todo task with no other parameters, just to keep things in mind
 
-Describe the action and its outcome.
+```
+todo <task-description>
+```
+
+Note, you cannot type todo on its own
 
-Example of usage: 
+### Add Events
+
+Adds a new event task with a timeframe 
+
+```
+event <task-description> /from <start> /to <end>
+```
 
-`keyword (optional arguments)`
+Note, the time frame currently does not follow any date/time standards so you can key in any timeframe you want
 
-Expected outcome:
+### Add Deadlines
 
-Description of the outcome.
+Adds a new deadline task with the by parameter to signify when you must finish the task
 
 ```
-expected output
+deadline <task-description> /by yyyy-mm-dd HH:mm
 ```
+Example: `deadline complete project /by 2024-03-20 23:59`
+
+Note, the `/by` parameter only accepts `yyyy-MM-dd HH:mm`
+
+### List
+
+Lists all of the tasks you currently have when you call `list`
+
+For dealines, they are listed according to their date time
+
+### Marking, Unmarking and Deleting
+
+Marks, unmarks or deletes a task according to its index in list
+
+Examples: `mark 1` or `unmark 2` or `delete 3`
+
+Note, the function currently does not support keying in multiple numbers
+
+### Finding
+
+Shows tasks that contain a certain `word` in their description
+
+Example: Calling `find book` will display all tasks that contain `book` in their description
+
+Note, the `word` used to locate a task is case sensitive
+
+### Exiting
+
+Calling `bye` or clicking on the red cross closes Zoe
+
+### Saving
+
+Data saving is done automatically everytime a todo, event or deadline is created

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