[Cao Peng] 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.
 
@@ -12,7 +12,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    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).
-1. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+1. After that, locate the `src/main/java/duke.Duke.java` file, right-click it, and choose `Run duke.Duke.main()`. If the setup is correct, you should see something like the below:
    ```
    Hello from
     ____        _        

build.gradle

@@ -0,0 +1,61 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+}
+
+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
+}
+
+checkstyle {
+    toolVersion = '8.29'
+}
+
+run{
+    standardInput = System.in
+}

data/duke.txt

@@ -0,0 +1,3 @@
+[T][X] homework
+[D][ ] return book (by: Oct 15 2019)
+[E][ ] project meeting (at: Oct 15 2019)

docs/README.md

@@ -7,14 +7,124 @@ Description of feature.
 
 ## Usage
 
-### `Keyword` - Describe action
-
-Describe action and its outcome.
+### `list` - List all the tasks in the current task list
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`list`
+
+Expected outcome:
+
+`_______________________________________________________`
+
+`1.[T][X]assignment`
+
+`2.[T][]homework`
+
+`_______________________________________________________`
+
+### `todo` - Add a task without any date/time attached to it
+
+Example of usage:
+
+`todo borrow book`
+
+Expected outcome:
+
+`_______________________________________________________`
+
+`Got it. I've added this task:`
+
+`[T][ ] borrow book`
+
+`Now you have 5 tasks in the list.`
+
+`______________________________________________________`
+
+### `deadline` - Add a task with deadline (e.g. 2019-10-15) attached to it
+
+Example of usage:
+
+`deadline return book /by 2019-10-15`
+
+Expected outcome:
+
+`____________________________________________`
+
+`     Got it. I've added this task:`
+
+`      [D][] return book (by: Oct 15 2019)Now you have 4 tasks in the list`
+
+`____________________________________________`
+
+### `event` - Add a task with date (e.g. 2019-10-15) attached to it
+
+Example of usage:
+
+`event project meeting /at 2019-10-15`
 
 Expected outcome:
 
-`outcome`
+`____________________________________________`
+
+`     Got it. I've added this task:`
+
+`      [E][] project meeting (by: Oct 15 2019)Now you have 5 tasks in the list`
+
+`____________________________________________`
+
+### `delete` - Delete a task from the list
+
+Example of usage:
+
+`list`
+
+`_______________________________________________________`
+
+`     Here are the tasks in your list:`
+
+`     1.[T][X] read book`
+
+`     2.[D][X] return book (by: June 6th)`
+
+`     3.[E][ ] project meeting (at: Aug 6th 2-4pm)`
+
+`     4.[T][X] join sports club`
+
+`     5.[T][ ] borrow book`
+
+`    _______________________________________________________`
+
+`delete 3`
+
+Expected outcome:
+
+`_______________________________________________________`
+
+`     Noted. I've removed this task: `
+
+`       [E][ ] project meeting (at: Aug 6th 2-4pm)`
+
+`    Now you have 4 tasks in the list.`
+
+`    ______________________________________________________`
+
+### `find` - Find a task by searching for a keyword
+
+Example of usage:
+
+`find book`
+
+Expected outcome:
+
+`_______________________________________________________`
+
+`     Here are the matching tasks in your list:`
+
+`     1.[T][X] read book`
+
+`     2.[D][X] return book (by: June 6th)`
+
+`_______________________________________________________`
+
+

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

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