[Zhang Yubin] ip

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# duke.main.Main.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.java` file, right-click it, and choose `Run duke.main.Main.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,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.main.Launcher"
+}
+
+shadowJar {
+    archiveBaseName = "Duke"
+    archiveClassifier = null
+}
+
+checkstyle {
+    toolVersion = '8.29'
+}
+
+run{
+    standardInput = System.in
+}

data/tasks.txt

@@ -0,0 +1 @@
+T | 1 | return book

docs/README.md

@@ -1,29 +1,187 @@
 # User Guide
+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. 
+
+You can download it from [Here](https://github.com/Kimowarui/ip/releases)
+
+## Introduction
+Duke frees your mind of having to remember things you need to do. It's,
+
+* text-based
+* easy to learn
+* SUPER FAST to use
+
+![Ui](/docs/Ui.png)
 
 ## Features 
 
-### Feature-ABC
+### 1. Feature-AddNewTask
+
+Add a task of "todo", "event", "deadline" type.
+
+### 2. Feature-ShowTaskList
+
+Show every task you have added into a list.
+
+### 3. Feature-MarkDone
+
+Mark a task as done.
+
+### 4. Feature-DeleteTask
+
+Delete a task in your list.
 
-Description of the feature.
+### 5. Feature-Save&Load
 
-### Feature-XYZ
+Save the tasks in the hard disk automatically whenever the task list changes. Load the data from the hard disk when Duke starts up. 
 
-Description of the feature.
+### 6. Feature-FindTask
+
+Find a list of task with given keyword.
 
 ## Usage
 
-### `Keyword` - Describe action
+### 1. `list` - List all the tasks
+
+Duke lists all the tasks added to a TaskList.
+
+Example of usage: 
+
+`list`
+
+Expected outcome:
+
+A list of tasks.
+
+```
+Here are tasks in your list: 
+1.[T][X] read a book
+2. [D][ ] return a book (by: 22/08/2019)
+```
+
+### 2. `done <index>` - Mark a task as done
+
+Duke marks a task as done.
+
+Example of usage: 
+
+`done 1`
+
+Expected outcome:
+
+Mark a specific task as done.
+
+```
+done:
+[T][X] return book
+```
+
+### 3. `delete <index>` - Delete a task
+
+Duke remove a task from a TaskList.
+
+Example of usage: 
+
+`delete 1`
+
+Expected outcome:
+
+Delete a specific task.
+
+```
+removed:
+[T][X] return book
+Now you have 1 tasks in the list.
+```
+
+### 4. `find <keyword>` - Search tasks
 
-Describe the action and its outcome.
+Duke searchs a list of tasks by given keyword.
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`find book`
 
 Expected outcome:
 
-Description of the outcome.
+A list of tasks containing the keyword.
 
 ```
-expected output
+Here are the matching tasks in your list:
+1.[D][ ] return a book (by: 22/08/2019)
+2.[T][ ] read a book
 ```
+
+### 5. `todo <task>` - Add a Todo task to TaskList
+
+Duke adds a Todo task to a TaskList.
+
+Example of usage: 
+
+`todo read a book`
+
+Expected outcome:
+
+Adds a Todo task into TaskList.
+
+```
+added: 
+[T][ ] read a book
+Now you have 2 tasks in the list.
+```
+
+### 6. `event <task> /at <time>` - Add a Event task to TaskList
+
+Duke adds a Event task to a TaskList.
+
+Example of usage: 
+
+`event borrow a book /at 2019=08-22`
+
+Expected outcome:
+
+Adds a Event task into TaskList.
+
+```
+added: 
+[E][ ] borrow a book (at: 22/08/2019)
+Now you have 3 tasks in the list.
+```
+
+### 7. `deadline <task> /by <time>` - Add a Deadline task to TaskList
+
+Duke adds a Deadline task to a TaskList.
+
+Example of usage: 
+
+`deadline return a book /at 2019=08-29`
+
+Expected outcome:
+
+Adds a Deadline task into TaskList.
+
+```
+added:
+[D][ ] return a book (by: 29/08/2019)
+Now you have 4 tasks in the list.
+```
+
+### 7. `snooze <index> <time>` - Change time of task
+
+Duke changes the time of a task.
+
+Example of usage: 
+
+`snooze 1 2019=08-29`
+
+Expected outcome:
+
+A task with newTiming replaces the original one.
+
+```
+You have successfully postpone a task!!!
+ Here are the delayed task with new timing:
+[D][ ] return a book (by: 29/08/2019)
+```
+

docs/_config.yml

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

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