[Vanessa] iP

README.md

@@ -1,24 +1,32 @@
-# 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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# GARY
+
+> "Get busy living or get busy dying." - Stephen King [source](https://atlasmedstaff.com/adventures-in-nursing/get-busy-living-or-get-busy-dying/)
+
+Gary frees your mind of having to remember things you need to do. It's,
+
+* text-based
+* easy to learn
+* ~~FAST~~ SUPER FAST to use
+
+All you need to do is,
+
+1. download it from [here.](https://github.com/vanessaxuuan/ip/releases/download/A-Release/ip-all.jar)
+2. double-click it.
+3. add your tasks.
+4. let it manage your tasks for you 😉
+
+**And it is FREE!**
+
+Features:
+- [x] Managing tasks
+- [x] Managing deadlines (coming soon)
+- [ ] Reminders (coming soon)
+
+If you Java programmer, you can use it to practice Java too. Here's the **main** method:
+```
+public class Main {
+    public static void main(String[] args) {
+        new Gary("./filepath).run();
+    }
+}
+```

build.gradle

@@ -0,0 +1,70 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    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 = "gary.Launcher"
+}
+
+//shadowJar {
+//    archiveBaseName = "Launcher"
+//    archiveClassifier = null
+//}
+
+jar {
+    manifest {
+        attributes(
+                'Main-Class': 'gary.Launcher'
+        )
+    }
+}
+
+//checkstyle {
+//    toolVersion = '8.29'
+//}
+
+run{
+    enableAssertions = true
+    standardInput = System.in
+}

docs/README.md

@@ -1,29 +1,104 @@
 # User Guide
+Gary is a desktop app for managing your daily to-do lists, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). 
 
 ## Features 
+1. [Adding tasks](https://github.com/vanessaxuuan/ip/blob/master/docs/README.md#adding-tasks): task_type
+2. [Deleting tasks](https://github.com/vanessaxuuan/ip/blob/master/docs/README.md#deleting-tasks): delete
+3. [Finding related tasks](https://github.com/vanessaxuuan/ip/blob/master/docs/README.md#finding-related-tasks): find
+4. [Listing out tasks](https://github.com/vanessaxuuan/ip/blob/master/docs/README.md#listing-out-tasks): list
+5. [Viewing help](https://github.com/vanessaxuuan/ip/blob/master/docs/README.md#viewing-help): help
+6. [Marking tasks](https://github.com/vanessaxuuan/ip/blob/master/docs/README.md#marking-and-un-marking-tasks): mark
+7. [Interactions](https://github.com/vanessaxuuan/ip/blob/master/docs/README.md#interactions) 
 
-### Feature-ABC
 
-Description of the feature.
+### 1. Adding Tasks
 
-### Feature-XYZ
+##### Adding different types of Task to your to-do list:
 
-Description of the feature.
+1. ToDo: 
 
-## Usage
+```
+[todo task_name] e.g. todo errands
+```
+
+2. Event
+
+```
+[event name / dd-mm-yyyy,hhmm] e.g. event party / 25-03-2022,2359
+```
+
+3. Deadline
+
+```
+[deadline name / dd-mm-yyyy,hhmm] e.g. deadline lab4 / 05-12-2022,1400
+```
+
+### 2. Deleting Tasks
+
+##### Delete Task(s)
+
+```
+[delete index ...] e.g. delete 5 3 1  or  delete 5
+```
+note: to delete multiple tasks at the same time, enter index in descending order
+
+##### Delete all Tasks
+
+```
+[refresh]
+```
+
+### 3. Finding related Tasks
+```
+[find keyword] e.g. find assignment
+```
+
+Output: A lists of tasks containing the keyword
+
+
+### 4. Listing out Tasks
+```
+[list]
+```
+ Output: Current to-do list
+
+
+### 5. Viewing Help
+```
+[help]
+```
+Output: command summary 
 
-### `Keyword` - Describe action
 
-Describe the action and its outcome.
+### 6. Marking and un-marking Tasks
 
-Example of usage: 
+##### Mark task(s) as done
+
+```
+[mark index ...] e.g. mark 1 4 2
+```
+note: can mark multiple tasks at the same time 
+
+outcome: e.g. T[X] errands 
+
+
+##### Mark task(s) as not done
+
+```
+[unmark index ...] e.g. unmark 1 5 2
+```
+note: can un-mark multiple tasks at the same time 
 
-`keyword (optional arguments)`
+outcome: e.g. T[ ] errands 
 
-Expected outcome:
 
-Description of the outcome.
+### 7. Interactions
 
+Input:
 ```
-expected output
+1. hi
+2. hello
+3. hey
+4. bye
 ```
+#### Try out these inputs to interact with Gary! 😉

gary.txt

@@ -0,0 +1,4 @@
+1. T[ ] groceries
+2. E[ ] birthday    on:   19 Dec 2022 23:59 pm
+3. D[ ] assignment   by:  01 Mar 2022 14:00 pm
+4. T[ ] run

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