Latest PR

README.md

@@ -1,24 +1,175 @@
-# 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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# SAGE iP project
+
+# User Guide For Sage Task Manager
+─────────────────────────────────────────────────────────────
+─██████████████─██████████████─██████████████─██████████████─
+─██░░░░░░░░░░██─██░░░░░░░░░░██─██░░░░░░░░░░██─██░░░░░░░░░░██─
+─██░░██████████─██░░██████░░██─██░░██████████─██░░██████████─
+─██░░██─────────██░░██──██░░██─██░░██─────────██░░██─────────
+─██░░██████████─██░░██████░░██─██░░██─────────██░░██████████─
+─██░░░░░░░░░░██─██░░░░░░░░░░██─██░░██──██████─██░░░░░░░░░░██─
+─██████████░░██─██░░██████░░██─██░░██──██░░██─██░░██████████─
+─────────██░░██─██░░██──██░░██─██░░██──██░░██─██░░██─────────
+─██████████░░██─██░░██──██░░██─██░░██████░░██─██░░██████████─
+─██░░░░░░░░░░██─██░░██──██░░██─██░░░░░░░░░░██─██░░░░░░░░░░██─
+─██████████████─██████──██████─██████████████─██████████████─
+─────────────────────────────────────────────────────────────
+
+## Features
+
+### Add Task (Todo, Event or Deadline)
+
+This feature allows the user to add a task to the task list. The user can add a task to the application.
+
+### Delete A Task
+
+To delete a task from the application
+
+### List All Tasks
+
+To list all tasks in the application
+
+### Find A Task
+
+To find tasks with a matching query in the task description.
+
+### Mark/Unmark Task
+
+You can mark/unmark a task as done/not done in the application.
+
+### Data Persistence Support
+
+Your previous session data will be automatically stored (in ./data/sage.txt) and restored (If applicable)
+
+## Usage
+
+### `Todo` - Add a Todo Task
+
+Adds a Todo task to the task list.
+
+Example of usage:
+
+`todo buy groceries`
+
+Expected outcome:
+
+```
+Got it. I've added this task:
+[T][ ] buy groceries
+Now you have X tasks in the list.
+```
+
+### `deadline` - Add a Deadline Task
+
+Adds a Deadline task to the task list.
+
+Example of usage:
+
+`deadline submit report /by 2022-03-31`
+
+Expected outcome:
+
+```
+Got it. I've added this task:
+[D][ ] submit report (by: 31 Mar 2022)
+Now you have X tasks in the list.
+```
+
+### `event` - Add an Event Task
+
+Adds an Event task to the task list.
+
+Example of usage:
+
+`event project meeting /from 2022-04-01 /to 2022-04-02`
+
+Expected outcome:
+
+```
+Got it. I've added this task:
+[E][ ] project meeting (from: 2022-04-01 to: 2022-04-02)
+Now you have X tasks in the list.
+```
+
+### `delete` - Delete a Task
+
+Deletes the specified task from the task list.
+
+Example of usage:
+
+`delete 2`
+
+Expected outcome:
+
+```
+Noted. I've removed this task:
+[D][ ] submit report (by: 31 Mar 2022)
+Now you have X tasks in the list.
+```
+
+### `find` - Find Tasks
+
+Displays a list of tasks that match the specified keyword.
+
+Example of usage:
+
+`find meeting`
+
+Expected outcome:
+
+```
+Found 1 matching queries!
+1.[E][ ] project meeting (from: 2022-04-01 to: 2022-04-02)
+```
+
+### `list` - List All Tasks
+
+Displays a list of all tasks in the task list.
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+```
+Here are the tasks in your list:
+1.[T][ ] buy groceries
+2.[E][ ] project meeting (from: 2022-04-01 to: 2022-04-02)
+```
+
+### `mark` - Mark a Task as Done
+
+Marks the specified task as done.
+
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
+
+```
+Nice! I've marked this task as done:
+[T][X] buy groceries
+```
+
+### `unmark` - Unmark a Task as Undone
+
+Marks the specified task as undone.
+
+Example of usage:
+
+`unmark 1`
+
+Expected outcome:
+
+```
+Noted. I've marked this task as undone:
+[T][ ] buy groceries
+```
+
+## Other Commands
+
+### `bye` - Quit the application
+
+Exit the application

data/sage.txt

@@ -0,0 +1,4 @@
+[T][ ] read book  
+[D][ ] return book (by: June 6th) 
+[T][ ] aasdadsada 
+[D][X] ajsdkaakd,as (by: wkjsdas) 

docs/README.md

@@ -1,29 +1,160 @@
-# User Guide
+# User Guide For Sage Task Manager
 
-## Features 
+## Features
 
-### Feature-ABC
+### Add Task (Todo, Event or Deadline)
 
-Description of the feature.
+This feature allows the user to add a task to the task list. The user can add a task to the application.
 
-### Feature-XYZ
+### Delete A Task
 
-Description of the feature.
+To delete a task from the application
+
+### List All Tasks
+
+To list all tasks in the application
+
+### Find A Task
+
+To find tasks with a matching query in the task description.
+
+### Mark/Unmark Task
+
+You can mark/unmark a task as done/not done in the application.
+
+### Data Persistence Support
+
+Your previous session data will be automatically stored (in ./data/sage.txt) and restored (If applicable)
 
 ## Usage
 
-### `Keyword` - Describe action
+### `Todo` - Add a Todo Task
 
-Describe the action and its outcome.
+Adds a Todo task to the task list.
 
-Example of usage: 
+Example of usage:
 
-`keyword (optional arguments)`
+`todo buy groceries`
 
 Expected outcome:
 
-Description of the outcome.
+```
+Got it. I've added this task:
+[T][ ] buy groceries
+Now you have X tasks in the list.
+```
+
+### `deadline` - Add a Deadline Task
+
+Adds a Deadline task to the task list.
+
+Example of usage:
+
+`deadline submit report /by 2022-03-31`
+
+Expected outcome:
 
 ```
-expected output
+Got it. I've added this task:
+[D][ ] submit report (by: 31 Mar 2022)
+Now you have X tasks in the list.
 ```
+
+### `event` - Add an Event Task
+
+Adds an Event task to the task list.
+
+Example of usage:
+
+`event project meeting /from 2022-04-01 /to 2022-04-02`
+
+Expected outcome:
+
+```
+Got it. I've added this task:
+[E][ ] project meeting (from: 2022-04-01 to: 2022-04-02)
+Now you have X tasks in the list.
+```
+
+### `delete` - Delete a Task
+
+Deletes the specified task from the task list.
+
+Example of usage:
+
+`delete 2`
+
+Expected outcome:
+
+```
+Noted. I've removed this task:
+[D][ ] submit report (by: 31 Mar 2022)
+Now you have X tasks in the list.
+```
+
+### `find` - Find Tasks
+
+Displays a list of tasks that match the specified keyword.
+
+Example of usage:
+
+`find meeting`
+
+Expected outcome:
+
+```
+Found 1 matching queries!
+1.[E][ ] project meeting (from: 2022-04-01 to: 2022-04-02)
+```
+
+### `list` - List All Tasks
+
+Displays a list of all tasks in the task list.
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+```
+Here are the tasks in your list:
+1.[T][ ] buy groceries
+2.[E][ ] project meeting (from: 2022-04-01 to: 2022-04-02)
+```
+
+### `mark` - Mark a Task as Done
+
+Marks the specified task as done.
+
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
+
+```
+Nice! I've marked this task as done:
+[T][X] buy groceries
+```
+
+### `unmark` - Unmark a Task as Undone
+
+Marks the specified task as undone.
+
+Example of usage:
+
+`unmark 1`
+
+Expected outcome:
+
+```
+Noted. I've marked this task as undone:
+[T][ ] buy groceries
+```
+
+## Other Commands
+
+### `bye` - Quit the application
+
+Exit the application

src/main/java/META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: sage.main.Sage
+