[yangyi-zhu] iP

README.md

@@ -1,26 +1,59 @@
-# Duke project template
+# 🥖 Baguette
 
-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.
+Baguette is a lightweight, command-line task management application designed to help users organize and track their tasks efficiently.
 
-## Setting up in Intellij
+---
 
-Prerequisites: JDK 17, 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 17** (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.
-1. 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:
+### 💻 Setup
+1. Ensure that you have Java 17 installed. Open CMD and type the following:
+    ```
+    java -version
+    ```
+   If another version is detected or if you do not have Java installed, visit:
+   > https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html
+2. Download `Baguette.v0_3.jar` from the following link and move it to any directory you desire
+   > https://github.com/yangyi-zhu/ip/releases/tag/v0.3
+3. Click the `.jar` file to run. If no window pops up, right-click, copy file path, open CMD and enter the following:
    ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
+   java -jar [path]
    ```
 
-**Warning:** Keep the `src\main\java` folder as the root folder for Java files (i.e., don't rename those folders or move Java files to another folder outside of this folder path), as this is the default location some tools (e.g., Gradle) expect to find Java files.
+---
+
+### 📌 Features
+
+### ✅ Task Management
+✍🏻 **Add Tasks:** Create different types of tasks, including:
+- **To-dos:** Simple tasks without a deadline.
+  > **Format:** `todo [description]` <br>
+  > **Example:** `todo Do the laundry`
+- **Deadlines:** Tasks with a specific due date.
+  > **Format:** `deadline [description] ddl: [DD-MM-YY HH:MM]` <br>
+  > **Example:** `deadline CS2113 Increment L5 ddl: 14-02-25 16:00`
+- **Events:** Tasks with a start and end time.
+  > **Format:** `event [description] from: [DD-MM-YY HH:MM] to: [DD-MM-YY HH:MM]` <br>
+  > **Example:** `event Josh's birthday party from: 03-03-25 15:00 to: 04-03-25 00:00`
+
+❌ **Mark & Unmark Tasks:** Keeps track of completed and pending tasks.
+> **Format:** `mark/unmark [index]`
+
+🗑️ **Delete Tasks:** Removes tasks that are no longer needed.
+> **Format:** `delete [index]`
+
+📋 **View Task List:** Displays all stored tasks in an organized format.
+> **Format:** `list`
+
+🔎 **Find Task:** Searches for tasks containing the given string (case-sensitive).
+> **Format:** `find [keyword]`
+
+---
+
+### ❓ FAQs
+**Q:** How do I transfer data to a friend or another device of my own? <br>
+**A:** Locate the directory where you stored the `.jar` file. Open `../data` and your list should be saved in a file called `tasks.txt`. Place this file in the `../data` directory on the secondary device and run the program as described above.
+
+---
+
+### 🛠️ Known Issues
+By default, completed tasks are marked with a checkmark `✓` symbol. This is not supported by all devices, and the user might see a question mark `?` in its place.
+> If this is the case, the user can fix this by forking and cloning this repository to their local device, and replacing the checkmark with another character at Line 67 in `src/main/java/baguette/datatypes/Task.java`.

data/tasks.txt

@@ -0,0 +1,2 @@
+D N eaijohdfa *$#24 Oct 2025 12:03
+E Y 12uasdhidusha :=&30 Mar 2025 16:00 +-+01 Apr 2025 02:00