[Zhu Le Yao] iP

.gitignore

@@ -13,5 +13,6 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+duke.txt
+tasks.txt

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: duke.main.Duke
+

build.gradle

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

data/archive.txt

@@ -0,0 +1,38 @@
+T / [ ] / a
+D / [ ] / b / Jan 01 2022 1800 PM
+E / [ ] / read book / Jan 01 2020 1800 PM-Jan 01 2020 2000 PM
+T / [ ] / d
+D / [ ] / b / Jan 01 2022 1800 PM
+T / [ ] / a
+T / [ ] / b
+T / [ ] / c
+D / [ ] / / Jan 01 2020 1800 PM
+T / [ ] / a
+T / [ ] / b
+T / [ ] / c
+T / [ ] / e
+T / [ ] / a
+T / [ ] / b
+T / [ ] / c
+E / [ ] / f / Jan 01 2020 1800 PM-Jan 01 2020 2000 PM
+T / [ ] / a
+T / [ ] / b
+T / [ ] / c
+T / [ ] / a
+T / [ ] / b
+T / [ ] / c
+T / [ ] / a
+T / [ ] / b
+T / [ ] / c
+T / [ ] / a
+T / [ ] / b
+T / [ ] / a
+T / [ ] / b
+T / [ ] / a
+T / [ ] / b
+T / [ ] / a
+T / [ ] / b
+T / [ ] / a
+T / [ ] / b
+T / [ ] / a
+T / [ ] / b

data/archiveAll.txt

@@ -0,0 +1,3 @@
+E / [ ] / f / Jan 01 2020 1800 PM-Jan 01 2020 2000 PM
+null
+null

docs/README.md

@@ -1,29 +1,116 @@
-# User Guide
+# Welcome to Duke
 
+>App that helps you to manage daily tasks e.g. deadlines, events, to do lists.
+
+## Environment settings
+This app requires Java version 11.
+
+You can go to your terminal and cd into the directory you downloaded the app into.
+```
+java -jar duke.jar
+```
 ## Features 
+1. Add a todo, deadline, or event task.
+2. Delete a task.
+3. Mark/ unmark a task as done.
+4. Archive your tasks.
+5. Search your tasks by keyword.
+6. Find out what tasks are happening/ due on a certain day.
+
+## Usage
+
+### `Keyword` - Describe action
 
-### Feature-ABC
+### `todo {description}` - Adds a Todo task
+Example of usage: 
 
-Description of the feature.
+`todo read book`
 
-### Feature-XYZ
+Expected outcome:
 
-Description of the feature.
+![todo](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/todo.png?raw=true)
+### `deadline {description} /by {deadline date}` - Adds a Deadline task
+Example of usage:
 
-## Usage
+`deadline read book /by 2020-01-01 1800`
 
-### `Keyword` - Describe action
+Expected outcome:
 
-Describe the action and its outcome.
+![deadline](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/deadline.png?raw=true)
 
-Example of usage: 
+### `event {description} /from {event start time} /to {event end time}` - Adds an event task
+Example of usage:
 
-`keyword (optional arguments)`
+`event read book /from 2020-01-01 1800 /to 2020-01-01 2000`
 
 Expected outcome:
 
-Description of the outcome.
+![event](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/event.png?raw=true)
+
+### `mark {index of task}` - Marks a task as done
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
+
+![mark](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/mark.png?raw=true)
+
+### `unmark {index of task}` - Unmarks a task
+Example of usage:
+
+`unmark 1`
+
+Expected outcome:
+
+![unmark](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/unmark.png?raw=true)
+
+### `delete {index of task}` - Deletes a task
+Example of usage:
+
+`delete 1`
+
+Expected outcome:
+
+![delete](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/delete.png?raw=true)
+
+### `find {description}` - Finds tasks containing description
+Example of usage:
+
+`find book`
+
+Expected outcome:
+
+![find](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/find.png?raw=true)
+
+### `show deadlines or events on {date}` - Shows tasks happening on specified date
+Example of usage:
+
+`show deadlines or events on 2020-01-01`
+
+Expected outcome:
+
+![show](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/showdeadlinesoreventson.png?raw=true)
+
+### `archive` - Archives current list of tasks into archiveAll.txt
+note: archive.txt contains all historical tasks.
+Example of usage:
+
+`archive`
+
+Expected outcome:
+
+![archive](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/archive.png?raw=true)
+
+### `list` - Shows current list of tasks
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+![list](https://github.com/ZhuLeYao/ip/blob/master/docs/README%20IMAGES/list.png?raw=true)
+
+### `bye` - Stops the app
+
 
-```
-expected output
-```

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