[andreusxcarvalho] iP

.gitignore

@@ -12,6 +12,10 @@ src/main/resources/docs/
 .DS_Store
 *.iml
 bin/
+loo
+# Ignore generated JAR files
+/out/artifacts/
 
+# Ignore test files
 /text-ui-test/ACTUAL.TXT
-text-ui-test/EXPECTED-UNIX.TXT
+/text-ui-test/EXPECTED-UNIX.TXT

README.md

@@ -1,24 +1,169 @@
-# 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 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.
-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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+
+
+# Andy Bot
+
+Welcome to **Andy Bot**, your personal assistant to manage tasks, deadlines, and events effortlessly. Andy helps you keep track of all your tasks with an easy-to-use interface, and all your inputs are stored safely so you never lose track of important tasks.
+
+## Overview
+
+Andy Bot is designed to help you stay on top of your task management. You can add, delete, and mark tasks as done, as well as search for specific tasks in your list. Andy supports three types of tasks: ToDo, Deadline, and Event tasks.
+
+### Task Types
+- **ToDo**: Task with just a name.
+- **Deadline**: Task with a name and a deadline.
+- **Event**: Task with a name, start time, and end time.
+
+### Storage
+Andy stores all your tasks in a file called **andy.txt** located in the `data` directory. If the file doesn't exist, Andy will automatically create it for you when you first run the application.
+
+## Running Andy Bot
+### Prerequisites:
+- Java version 11 or higher installed
+- Latest JAR file of Andy Bot
+
+### Steps to Run:
+1. Open your terminal or command prompt.
+2. Change directory to the location where the JAR file is stored.
+3. Run the command:
+   ```bash
+   java -jar andy.jar.jar
+
+To exit the application, simply type `bye`.
+
+## Features
+
+### 1. List All Tasks
+**Command**: `list`
+
+Displays all tasks in the current list.
+
+### 2. Add a ToDo Task
+**Command**: `todo NAME`
+
+Adds a task with the specified name.
+
+**Example**:
+```
+todo Complete CS2103T project
+```
+
+**Expected Outcome**:
+```
+Added: Complete CS2103T project
+```
+
+### 3. Add a Deadline Task
+**Command**: `deadline NAME /by DEADLINE`
+
+Adds a task with a specified deadline.
+
+**Example**:
+```
+deadline Submit report /by 2024-10-11
+```
+
+**Expected Outcome**:
+```
+Added: Submit report (by: 2024-10-11)
+```
+
+### 4. Add an Event Task
+**Command**: `event NAME /from START /to END`
+
+Adds an event task with a start and end time.
+
+**Example**:
+```
+event Project meeting /from 2024-10-10 2PM /to 2024-10-10 4PM
+```
+
+**Expected Outcome**:
+```
+Added: Project meeting (from: 2024-10-10 2PM to 2024-10-10 4PM)
+```
+
+### 5. Mark a Task as Done
+**Command**: `mark INDEX`
+
+Marks a task at the specified index as done.
+
+**Example**:
+```
+mark 1
+```
+
+**Expected Outcome**:
+```
+Nice! I've marked this task as done:
+[X] Complete CS2103T project
+```
+
+### 6. Unmark a Task
+**Command**: `unmark INDEX`
+
+Marks a task at the specified index as not done.
+
+**Example**:
+```
+unmark 1
+```
+
+**Expected Outcome**:
+```
+OK, I've marked this task as not done yet:
+[ ] Complete CS2103T project
+```
+
+### 7. Delete a Task
+**Command**: `delete INDEX`
+
+Deletes the task at the specified index.
+
+**Example**:
+```
+delete 1
+```
+
+**Expected Outcome**:
+```
+Deleted: Complete CS2103T project
+```
+
+### 8. Find Tasks by Keyword
+**Command**: `find KEYWORD`
+
+Finds and displays all tasks that match the specified keyword.
+
+**Example**:
+```
+find project
+```
+
+**Expected Outcome**:
+```
+Here are the matching tasks in your list:
+1. [T][ ] Complete CS2103T project
+```
+
+### 9. Exit the Application
+**Command**: `bye`
+
+Closes Andy Bot and saves your tasks.
+
+**Example**:
+
+```
+bye
+```
+
+**Expected Outcome**
+```
+Bye. Hope to see you again soon!
+```
+
+
+
+
+
+
+

data/andy.txt

@@ -0,0 +1,6 @@
+T | 1 | 1
+T | 1 | ..
+T | 0 | 3
+T | 0 | 22
+T | 0 | 5
+T | 0 | 5

docs/README.md

@@ -1,30 +1,167 @@
-# Duke User Guide
+# Andy Bot
 
-// Update the title above to match the actual product name
+Welcome to **Andy Bot**, your personal assistant to manage tasks, deadlines, and events effortlessly. Andy helps you keep track of all your tasks with an easy-to-use interface, and all your inputs are stored safely so you never lose track of important tasks.
 
-// Product screenshot goes here
+## Overview
 
-// Product intro goes here
+Andy Bot is designed to help you stay on top of your task management. You can add, delete, and mark tasks as done, as well as search for specific tasks in your list. Andy supports three types of tasks: ToDo, Deadline, and Event tasks.
 
-## Adding deadlines
+### Task Types
+- **ToDo**: Task with just a name.
+- **Deadline**: Task with a name and a deadline.
+- **Event**: Task with a name, start time, and end time.
 
-// Describe the action and its outcome.
+### Storage
+Andy stores all your tasks in a file called **andy.txt** located in the `data` directory. If the file doesn't exist, Andy will automatically create it for you when you first run the application.
 
-// Give examples of usage
+## Running Andy Bot
+### Prerequisites:
+- Java version 11 or higher installed
+- Latest JAR file of Andy Bot
 
-Example: `keyword (optional arguments)`
+### Steps to Run:
+1. Open your terminal or command prompt.
+2. Change directory to the location where the JAR file is stored.
+3. Run the command:
+   ```bash
+   java -jar Andy.jar
 
-// A description of the expected outcome goes here
+To exit the application, simply type `bye`.
 
+## Features
+
+### 1. List All Tasks
+**Command**: `list`
+
+Displays all tasks in the current list.
+
+### 2. Add a ToDo Task
+**Command**: `todo NAME`
+
+Adds a task with the specified name.
+
+**Example**:
+```
+todo Complete CS2103T project
+```
+
+**Expected Outcome**:
+```
+Added: Complete CS2103T project
+```
+
+### 3. Add a Deadline Task
+**Command**: `deadline NAME /by DEADLINE`
+
+Adds a task with a specified deadline.
+
+**Example**:
+```
+deadline Submit report /by 2024-10-11
+```
+
+**Expected Outcome**:
+```
+Added: Submit report (by: 2024-10-11)
 ```
-expected output
+
+### 4. Add an Event Task
+**Command**: `event NAME /from START /to END`
+
+Adds an event task with a start and end time.
+
+**Example**:
 ```
+event Project meeting /from 2024-10-10 2PM /to 2024-10-10 4PM
+```
+
+**Expected Outcome**:
+```
+Added: Project meeting (from: 2024-10-10 2PM to 2024-10-10 4PM)
+```
+
+### 5. Mark a Task as Done
+**Command**: `mark INDEX`
+
+Marks a task at the specified index as done.
+
+**Example**:
+```
+mark 1
+```
+
+**Expected Outcome**:
+```
+Nice! I've marked this task as done:
+[X] Complete CS2103T project
+```
+
+### 6. Unmark a Task
+**Command**: `unmark INDEX`
+
+Marks a task at the specified index as not done.
+
+**Example**:
+```
+unmark 1
+```
+
+**Expected Outcome**:
+```
+OK, I've marked this task as not done yet:
+[ ] Complete CS2103T project
+```
+
+### 7. Delete a Task
+**Command**: `delete INDEX`
+
+Deletes the task at the specified index.
+
+**Example**:
+```
+delete 1
+```
+
+**Expected Outcome**:
+```
+Deleted: Complete CS2103T project
+```
+
+### 8. Find Tasks by Keyword
+**Command**: `find KEYWORD`
+
+Finds and displays all tasks that match the specified keyword.
+
+**Example**:
+```
+find project
+```
+
+**Expected Outcome**:
+```
+Here are the matching tasks in your list:
+1. [T][ ] Complete CS2103T project
+```
+
+### 9. Exit the Application
+**Command**: `bye`
+
+Closes Andy Bot and saves your tasks.
+
+**Example**:
+
+```
+bye
+```
+
+**Expected Outcome**
+```
+Bye. Hope to see you again soon!
+```
+
+
 
-## Feature ABC
 
-// Feature details
 
 
-## Feature XYZ
 
-// Feature details