Add User Guide

data/tasks.txt

@@ -1,5 +1,5 @@
 
-T/0/newdesc
-D/1//2020-09-23
-T/0/blah
-T/0/blah234
+E/0/midterm/2020-09-30
+T/0/submit 2103t ip
+E/0/New Years' Party/2020-09-23
+D/0/return book/2020-09-30

docs/README.md

@@ -1,20 +1,161 @@
 # User Guide
 
-## Features 
-
-### Feature 1 
-Description of feature.
+Welcome to Duke 2.0, the tired, sarcastic, done-with-life version that encourages you to be your worst self! Enjoy :)
 
 ## Usage
 
-### `Keyword` - Describe action
+### `todo <description>` - Add Todo task
+
+Adds a new Todo item to current list of tasks, with description as specified.
+
+Example of usage: 
+
+`todo submit 2103t ip`
+
+Expected outcome:
+
+```
+You're making me feel tired... But if you insist, I've added this:`
+
+[T][:(] submit 2103t ip
+
+You now have 1 thing in your list.
+```
+
+### `deadline <description> /by <date>` - Add Deadline task
+
+Adds a new Deadline item to current list of tasks, with description and date as specified.
+
+*Date must be in YYYY-MM-DD format.*
+
+Example of usage: 
+
+`deadline return book /by 2020-09-30`
+
+Expected outcome:
+
+```
+You're making me feel tired... But if you insist, I've added this:
+
+[D][:(] return book (by: WEDNESDAY, Sep 30 2020)
+
+You now have 2 things in your list.
+```
+
+### `event <description> /at <date>` - Add Event task
+
+Adds a new Event item to current list of tasks, with description and date as specified.
+
+*Date must be in YYYY-MM-DD format.*
+
+Example of usage: 
+
+`event party /at 2020-09-23`
+
+Expected outcome:
+
+```
+You're making me feel tired... But if you insist, I've added this:
+
+[E][:(] party (at: WEDNESDAY, Sep 23 2020)
+
+You now have 3 things in your list.
+```
+### `list` - List all tasks
+
+Displays a list of all tasks currently existing.
+
+Example of usage: 
+
+`list`
+
+Expected outcome:
+
+```
+1. [T][:(] submit 2103t ip
+2. [D][:(] return book (by: WEDNESDAY, Sep 30 2020)
+3. [E][:(] party (at: WEDNESDAY, Sep 23 2020)
+
+I wouldn't bother about them if I were you.
+
+You now have 3 things in your list.
+```
+### `done <task number>` - Mark a task as done
+
+Marks as done the task specified by the task number.
+
+*Numbering is as shown with a `list` command.*
+
+Example of usage: 
+
+`done 1`
+
+Expected outcome:
+
+```
+Oh goody... You actually accomplished something!!!
+  [T][:)] submit 2103t ip
+```
+
+### `delete <task number>` - Delete a task
+
+Deletes a task from current list of tasks, as specified by the task number.
+
+*Numbering is as shown with a `list` command.*
+
+Example of usage: 
+
+`delete 1`
+
+Expected outcome:
+
+```
+Oh, getting lazy are we? I approved. I've removed this:
+  [T][:)] submit 2103t ip
+
+You now have 2 things in your list.
+```
+### `find <keyword>` - Find tasks related to `keyword`
+
+Gives a list of tasks that contain `keyword` in their description.
+
+Example of usage: 
+
+`find party`
+
+Expected outcome:
+
+```
+1. [E][:(] party (at: WEDNESDAY, Sep 23 2020)
+
+I wouldn't bother about them if I were you.
+```
+### `update <task number> <new description>` - Updates description of a task
+
+Updates the description of a task (as specified by `task number`) to `new description`.
+
+*Numbering is as shown with a `list` command.*
+
+Example of usage: 
+
+`update 2 New Years' Party`
+
+Expected outcome:
+
+```
+Donezorimasu. Your task is now:
+ [E][:(] New Years' Party (at: WEDNESDAY, Sep 23 2020)
+```
+### `bye / toodles / sayonara / farewell` - Exits app
 
-Describe action and its outcome.
+Exits the app and saves current list of tasks.
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`toodles`
 
 Expected outcome:
 
-`outcome`
+```
+Finally... don't come back if you can possibly help it, please.
+```

src/main/java/duke/Main.java

@@ -24,6 +24,7 @@ public void start(Stage stage) {
             Scene scene = new Scene(ap);
             stage.setScene(scene);
             fxmlLoader.<MainWindow>getController().setDuke(duke);
+            stage.setTitle("Duke");
             stage.show();
         } catch (IOException e) {
             e.printStackTrace();

src/main/java/duke/Ui.java

@@ -21,7 +21,7 @@ protected Ui() {}
     private enum Speech {
         GREETING("My name? You don't need to know that. Stop bothering me already... "),
         BYE("Finally... don't come back if you can possibly help it, please."),
-        LIST("\nI wouldn't bother doing them if I were you."),
+        LIST("\nI wouldn't bother about them if I were you."),
         DONE("Oh goody... You actually accomplished something!!\n  "),
         ADD("You're making me feel tired... But if you insist, I've added this:\n  "),
         DELETE("Oh, getting lazy are we? I approve. I've removed this:\n  "),

src/main/java/duke/task/Task.java

@@ -22,6 +22,7 @@ public Task(String description) {
         this.isDone = false;
     }
 
+    // Use of second constructor learnt from Lim Jia Rui Ryan's IP
     /**
      * Constructor for tasks loaded in from data file,
      * where it's known whether the task is done or not.

src/main/resources/view/MainWindow.fxml

@@ -9,7 +9,7 @@
 <AnchorPane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="600.0" prefWidth="400.0" xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1" fx:controller="duke.gui.MainWindow">
     <children>
         <TextField fx:id="userInput" layoutY="558.0" onAction="#handleUserInput" prefHeight="41.0" prefWidth="324.0" AnchorPane.bottomAnchor="1.0" />
-        <Button fx:id="sendButton" layoutX="324.0" layoutY="558.0" mnemonicParsing="false" onAction="#handleUserInput" prefHeight="41.0" prefWidth="76.0" text="Send" />
+        <Button fx:id="sendButton" layoutX="324.0" layoutY="558.0" mnemonicParsing="false" onAction="#handleUserInput" prefHeight="41.0" prefWidth="76.0" text="Whee" />
         <ScrollPane fx:id="scrollPane" hbarPolicy="NEVER" hvalue="1.0" prefHeight="557.0" prefWidth="400.0" vvalue="1.0">
             <content>
                 <VBox fx:id="dialogContainer" minHeight="552.0" prefWidth="388.0" />