[Fahim Tajwar] iP

README.md

@@ -1,24 +1,71 @@
-# 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.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11, update Intellij to the most recent version.
-
-1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
-   1. Click `Open`.
-   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).<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:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# Chad Personal Assistant User Guide
+
+## Features 
+
+- Maintain a list of Tasks, Deadlines and Events.
+- View your list at any time with a simple command `list`.
+- Mark each item as Done or Not Done.
+- Delete obsolete tasks.
+
+## Quick Start Guide
+1. Download the latest Chad version from [here](https://github.com/fahim-tazz/ip/releases).
+2. Open your Terminal/Command Prompt.
+3. Type `cd Downloads` (or wherever the `chad.jar` file is stored).
+4. Type in `java -jar chad.jar`.
+5. Type in commands to use Chad.
+6. Enjoy!
+
+---
+
+## Usage
+
+### `list` - List all current tasks.
+
+Lists down all current tasks saved by Chad.
+- T, D and E represent Todo, Deadline and Event tasks respectively.
+- `[ ]` and `[X]` show whether a task is `Not Done` or `Done`, respectively.
+
+
+### `todo [task name]` - Add a new Todo item.
+
+Adds a new Todo task to your list.
+
+### `deadline [task name] /by [due date YYYY-MM-DD]` - Add a new Deadline item.
+
+Adds a new Deadline task to your list. 
+- The name should be followed by a ` /by ` keyword. 
+- The due date should come after the ` by `, and be in the format `YYYY-MM-DD`.
+
+### `event [event name] /from [start time] /to [end time]` - Add a new Event item.
+
+Adds a new Event to your list.
+- The name should be followed by a ` /from ` keyword.
+- The start time should come after the ` /from ` keyword, followed by ` /to `.
+- The end time should come after the ` /to ` keyoword.
+- Start and End times do not have any format constraints.
+
+### `mark [task no.]` - Marks a task as done.
+
+Marks the task at that serial number as done.
+- Task numbers start from 1, and follow the ordering shown by the `list` command.
+
+### `unmark [task no.]` - Marks a task as NOT done.
+
+Marks the task at that serial number as NOT done.
+- Task numbers start from 1, and follow the ordering shown by the `list` command.
+
+### `delete [task no.]` - Removes a task from the list.
+
+Permanently deletes the task at that serial number from the list.
+- Task numbers start from 1, and follow the ordering shown by the `list` command.
+- Deleted tasks CANNOT be recovered.
+
+### `find [search phrase]` - Finds any task that matches with the search phrase.
+
+Searches for any task that contains the search phrase.
+- Search is CASE-SENSITIVE. `laundry` will NOT match with a task named `Do Laundry`.
+
+### `bye` - Saves the current tasks and exits Chad.
+
+Saves the current task list on your computer, and exits Chad. Tasks will be retrieved the next time you open Chad.
+- You can also exit by clicking the [X] button on the Chad window. Don't worry, Chad will save your tasks no matter what!

build.gradle

@@ -0,0 +1,65 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'checkstyle'
+}
+
+repositories {
+    mavenCentral()
+}
+
+checkstyle {
+    sourceSets = []
+}
+
+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 = "chad.frontend.Main"
+}
+
+shadowJar {
+    archiveBaseName = "chad"
+    archiveClassifier = null
+}
+
+run{
+    standardInput = System.in
+}
+
+checkstyle {
+    toolVersion = '10.2'
+}