Merge pull request #4 from ziyi22/branch-A-UserGuide

Implement A-User Guide

Author: ziyi22

docs/Judy.png

@@ -1,30 +1,120 @@
-# Duke User Guide
+# Judy User Guide
 
-// Update the title above to match the actual product name
+![judy image](./Judy.png)
 
-// Product screenshot goes here
+> Hi, I'm Judy! Your digital assistant for productivity.
 
-// Product intro goes here
+## Start Using Judy
+1. Click [here]() to download Judy.
+2. Navigate to your Downloads folder using the terminal.
+3. Enter `java -jar Judy.jar` in your terminal.
+4. Press enter.
+5. Start manage your task
 
-## Adding deadlines
+## Adding todo
 
-// Describe the action and its outcome.
+Add a todo task in your list.
 
-// Give examples of usage
+Example: `todo laundry`
 
-Example: `keyword (optional arguments)`
+Expected output:
+```
+Got it! I've added this task:
+   [T][ ] laundry
+   Now you have 1 tasks in the list. 
+```
+
+## Adding Deadline
+
+Add a deadline task in your list.
+
+Example: `deadline Assignment 1 /by 2025-03-01 2359`
+
+Expected output:
+```
+Got it! I've added this task:
+   [D][ ] Assignment 1 (by: Jan 03 2025 11:59 PM)
+   Now you have 2 tasks in the list. 
+```
+
+## Adding Event
+
+Add an event task in your list.
+
+Example: `event CNY party /from 2024-05-05 1400 /to 2024-05-05 2200`
+
+Expected output:
+```
+Got it! I've added this task:
+   [E][ ] CNY party (from: May 05 2024 02:00 PM to: May 05 2024 10:00 PM)
+   Now you have 3 tasks in the list. 
+```
+## Displaying task list
+
+Display all the tasks in your task list.
+
+Example: `list`
+
+Expected output:
+```
+Here are the tasks in your task list:
+   1. [T][ ] laundry
+   2. [D][ ] Assignment 1 (by: Jan 03 2025 11:59 PM)
+   3. [E][ ] CNY party (from: May 05 2024 02:00 PM to: May 05 2024 10:00 PM)
+```
+
+## Mark a task
+
+Use `mark` to mark a task as done by specifying the task index.
+The task index must be a positive integer.
+
+Example: `mark 1`
+
+Expected output:
+```
+Nice! I've marked this task as done:
+   [T][X] laundry
+```
+
+## Unmark a task
+
+Use `unmark` to mark a task as undone by specifying the task index.
+The task index must be a positive integer.
 
-// A description of the expected outcome goes here
+Example: `unmark 1`
 
+Expected output:
 ```
-expected output
+Nice! I've unmarked this task as done:
+   [T][ ] laundry
 ```
 
-## Feature ABC
+## Delete a task
 
-// Feature details
+Use `delete` to delete a task by specifying the task index.
+The task index must be a positive integer.
 
+Example: `delete 1`
+
+Expected output:
+```
+Noted. I've removed this task:
+   [T][ ] laundry
+   Now you have 2 tasks in the list.
+```
+
+## Finding a task
+
+Use `find` to find a task using keyword.
+
+Example: `find Assingment`
+
+Expected output:
+```
+Here are the matching tasks in your list:
+   1. [D][ ] ssignment 1 (by: Jan 03 2025 11:59 PM)
+```
 
-## Feature XYZ
+## Exit Judy
 
-// Feature details
+Use `bye` to exit the chat.

docs/README.md

@@ -1,9 +1,5 @@
- T | 0 | haha
- D | 1 | assignment 1 | May 05 2023 11:59 PM
- T | 0 | ziyi
  E | 0 | formal night | Dec 12 2024 06:00 PM - Dec 12 2024 10:00 PM
  T | 0 | grocery
  T | 0 | return book
  T | 0 | borrow book
- T | 0 | hi
- T | 0 | haha
+ D | 0 | project | Feb 02 2024 11:59 PM

judy.txt

@@ -43,7 +43,7 @@ private DialogBox(String text, Image img, boolean isUser) {
 
         Rectangle clip = new Rectangle(200, 200);
         dialog.setText(text);
-        dialog.setWrappingWidth(300);
+        //dialog.setWrappingWidth(300);
         displayPicture.setImage(img);
         displayPicture.setClip(clip);
     }

src/main/java/judy/javafx/DialogBox.java

@@ -22,15 +22,15 @@ public class Messages {
      * @return The help message.
      */
     public static String helpMessage() {
-        return (" Here are the commands that I understand!\n"
-                + "   1. To add a todo, type 'todo <description>'\n"
-                + "   2. To add a deadline, type 'deadline <description> /by <yyyy-mm-dd HHmm>' \n"
-                + "   3. To add an event, type 'event <description> /from <yyyy-mm-dd HHmm> /to <yyyy-mm-dd HHmm>'\n"
-                + "   4. To list out your tasks, type 'list'\n"
-                + "   5. To mark a task as done, type 'mark <task number>' \n"
-                + "   6. To mark a task as undone, type 'unmark <task number>' \n"
-                + "   7. To delete a task, type 'delete <task number>' \n"
-                + "   8. To exit the chat, type 'bye'\n"
+        return ("Here are the commands that I understand!\n"
+                + "To add a todo, type 'todo <description>'\n"
+                + "To add a deadline, type 'deadline <description> /by <yyyy-mm-dd HHmm>' \n"
+                + "To add an event, type 'event <description> /from <yyyy-mm-dd HHmm> /to <yyyy-mm-dd HHmm>'\n"
+                + "To list out your tasks, type 'list'\n"
+                + "To mark a task as done, type 'mark <task number>' \n"
+                + "To mark a task as undone, type 'unmark <task number>' \n"
+                + "To delete a task, type 'delete <task number>' \n"
+                + "To exit the chat, type 'bye'"
             );
     }
 

src/main/java/judy/ui/Messages.java

@@ -9,21 +9,22 @@
     <style>
         -fx-padding: 10px;
     </style>
-    <HBox maxHeight="2E308" maxWidth="2E308" prefWidth="500.0">
+    <HBox layoutY="10.0" maxHeight="2E308" maxWidth="2E308" prefHeight="174.0" prefWidth="400.0">
         <style>
             -fx-background-color: #FECBBB;
-            -fx-background-radius: 30px;
+            -fx-background-radius: 25px;
             -fx-spacing: 10px;
             -fx-padding: 20px;
         </style>
         <padding>
             <Insets bottom="15.0" left="5.0" right="5.0" top="15.0" />
         </padding>
-        <ImageView fx:id="displayPicture" fitHeight="120" fitWidth="100" preserveRatio="true">
+        <ImageView fx:id="displayPicture" fitHeight="102.0" fitWidth="95.0" preserveRatio="true">
          <HBox.margin>
-            <Insets bottom="0.0"/>
+            <Insets bottom="0.0" />
          </HBox.margin></ImageView>
-        <Text fx:id="dialog" text="Label" textAlignment="LEFT">
+
+        <Text fx:id="dialog" lineSpacing="2.0" text="Label" wrappingWidth="350.0">
             <font>
                 <Font name="Comic Sans MS" size="16.0" />
             </font>

src/main/resources/view/DialogBox.fxml

@@ -4,7 +4,7 @@
 <?import javafx.scene.layout.*?>
 <?import javafx.scene.text.*?>
 
-<AnchorPane prefHeight="600" prefWidth="600" xmlns="http://javafx.com/javafx/17.0.2-ea" xmlns:fx="http://javafx.com/fxml/1" fx:controller="judy.javafx.MainWindow">
+<AnchorPane prefHeight="600" prefWidth="450" xmlns="http://javafx.com/javafx/17.0.2-ea" xmlns:fx="http://javafx.com/fxml/1" fx:controller="judy.javafx.MainWindow">
 
     <!-- Root layout -->
     <children>

src/main/resources/view/MainWindow.fxml

@@ -9,22 +9,22 @@
     <style>
         -fx-padding: 10 10 10 90;
     </style>
-    <HBox maxHeight="2E308" maxWidth="2E308" prefWidth="500">
+    <HBox maxHeight="2E308" maxWidth="2E308" prefWidth="550">
         <style>
             -fx-background-color: #AAD9BB;
-            -fx-background-radius: 30px;
+            -fx-background-radius: 25px;
             -fx-spacing: 10px;
             -fx-padding: 20px;
         </style>
         <padding>
             <Insets bottom="15.0" left="5.0" right="4.0" top="15.0" />
         </padding>
-        <Text fx:id="dialog" text="Label" textAlignment="RIGHT" >
+        <Text fx:id="dialog" text="Label" textAlignment="RIGHT" wrappingWidth="300">
             <font>
                 <Font name="Comic Sans MS" size="16.0" />
             </font>
         </Text>
-        <ImageView fx:id="displayPicture" fitHeight="80" fitWidth="80" preserveRatio="true" />
+        <ImageView fx:id="displayPicture" fitHeight="102.0" fitWidth="95.0" preserveRatio="true" />
         <HBox.margin>
             <Insets bottom="15.0" left="5.0" right="5.0" top="15.0" />
         </HBox.margin>