[LimHongYao] iP

README.md

@@ -1,24 +1,149 @@
-# 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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# Anna
+
+Anna is a chatbot that helps you to organise your tasks. It can add,
+delete and mark done tasks you've listed. It can also help you keep track of deadlines
+and calender events.
+
+Anna runs on a simple CLI interface that is lightweight and cross-platform friendly.
+Anna is also designed to be friendly to first time users by being capable of handling missing inputs
+
+## Setting up
+
+Prerequisites: JDK 11
+1. Download the ip.jar under 'Releases'
+2. Extract the file into a folder you wish to keep it (e.g. `C:\Users\<username>\Desktop\AnnaBot`)
+3. Open a terminal (e.g Command Prompt for Windows) and navigate to the previous directory<br>
+4. Run the jar file using command `java -jar ip.jar`<br>
+#### Example (Windows Command Prompt):
+```
+C:\Users\user> cd Desktop\AnnaBot
+C:\Users\user\Desktop\AnnaBot> java -jar ip.jar
+Hi it's Anna!
+What do you need to do?
+You may load existing data using the load command
+```
+
+## Commands
+To interact with Anna, please use the following commands
+
+### exit the program: `bye`
+This command exits the running instance.
+```
+bye
+Go away Anna
+O-kay bye......
+```
+### view the current tasklist: `list`
+`list` will show the current tasklist in order of addition (oldest task first)
+```
+todo task1
+Okay! I've added: [T] task1
+event task2 /from today /to tomorrow
+Okay! I've added: [E] task2
+list
+Here's what we've gotta do:
+1. [T][ ] task1
+2. [E][ ] task2
+    Start: from today
+    End: to tomorrow
+We currently have 2 tasks
+```
+
+### Mark task as done: `mark <task number>`
+Sets a given task as completed. Yay!
+```
+mark 1
+Okay I've marked item 1 as done:
+1. [T][X] task1
+```
+
+### Mark task as not done: `unmark <task number>`
+Sets a given task as not done
+```
+unmark 1
+Oh we aren't done with item 1?
+1. [T][ ] task1
+```
+
+### Create a simple todo task: `todo <task description>`
+Creates a standard todo task and adds it into the tasklist
+```
+todo task1
+Okay! I've added: [T] task1
+```
+Anna will prompt you if you forget to input the name of the task
+```
+todo
+What are you referring to?
+task1
+Okay! I've added: [T] task1
+```
+### Create a task with a deadline: `deadline <task description> /by <duedate>`
+Creates a task with a deadline and adds it into the tasklist
+```
+deadline task2 /by 5 jan
+Okay! I've added: [D] task2
+```
+Anna will prompt you for the deadline if it is missing
+```
+deadline task2
+When is this due by?
+5 jan
+Okay! I've added: [D] task2
+```
+### Create a task with start and end dates:<br/>`event <task description> /from <startdate> /to <enddate>`
+Creates a task with start and end times and adds it into the tasklist
+```
+event task3 /from today /to tomorrow
+Okay! I've added: [E] task3
+```
+Similarly to `deadline`, Anna will prompt you if you are missing date details
+```
+event task3 /to tomorrow
+When does this event start?
+today
+Okay! I've added: [E] task3
+```
+### Remove a task: `delete <task number>`
+The given task will be deleted from the tasklist
+```
+delete 1
+Okay! I've deleted task: 1
+```
+### Loading and Saving of tasklist
+Anna also supports import/export of your tasklist in the form of a .txt file. This can be helpful if you want to refer to the tasklist in a future date!
+
+`save` exports the current tasklist into a tasklist.txt file
+```
+save
+Successfully exported TaskList!
+Written to: C:\Users\lhyao\Desktop\TaskList.txt
+```
+`load` imports a previous tasklist into the program's tasklist <br>
+Anna looks for a `TaskList.txt` file in the same directory to import from
+```
+load
+Okay! I've added: [D] task2
+Okay! I've added: [D] task2
+Okay! I've added: [E] task3
+Okay! I've added: [E] task3
+Okay! I've added: [T] task1
+```
+## Usage Example
+
+#### Input Example 1
+`deadline ip /by tonight`
+
+#### Expected Output 1
+`Okay! I've added: [D] ip`
+
+#### Input Example 2
+`list`
+
+#### Expected Output 2
+```
+Here's what we've gotta do:
+1. [D][ ] ip 
+    Deadline: tonight
+We currently have 1 tasks
+```

docs/README.md

@@ -1,29 +1,149 @@
-# User Guide
+# Anna
 
-## Features 
+Anna is a chatbot that helps you to organise your tasks. It can add, 
+delete and mark done tasks you've listed. It can also help you keep track of deadlines 
+and calender events.
 
-### Feature-ABC
+Anna runs on a simple CLI interface that is lightweight and cross-platform friendly. 
+Anna is also designed to be friendly to first time users by being capable of handling missing inputs
 
-Description of the feature.
+## Setting up
 
-### Feature-XYZ
+Prerequisites: JDK 11
+1. Download the ip.jar under 'Releases'
+2. Extract the file into a folder you wish to keep it (e.g. `C:\Users\<username>\Desktop\AnnaBot`)
+3. Open a terminal (e.g Command Prompt for Windows) and navigate to the previous directory<br>
+4. Run the jar file using command `java -jar ip.jar`<br>
+#### Example (Windows Command Prompt):
+```
+C:\Users\user> cd Desktop\AnnaBot
+C:\Users\user\Desktop\AnnaBot> java -jar ip.jar
+Hi it's Anna!
+What do you need to do?
+You may load existing data using the load command
+```
 
-Description of the feature.
+## Commands
+To interact with Anna, please use the following commands
 
-## Usage
+### exit the program: `bye`
+This command exits the running instance.
+```
+bye
+Go away Anna
+O-kay bye......
+```
+### view the current tasklist: `list`
+`list` will show the current tasklist in order of addition (oldest task first)
+```
+todo task1
+Okay! I've added: [T] task1
+event task2 /from today /to tomorrow
+Okay! I've added: [E] task2
+list
+Here's what we've gotta do:
+1. [T][ ] task1
+2. [E][ ] task2
+    Start: from today
+    End: to tomorrow
+We currently have 2 tasks
+```
 
-### `Keyword` - Describe action
+### Mark task as done: `mark <task number>` 
+Sets a given task as completed. Yay!
+```
+mark 1
+Okay I've marked item 1 as done:
+1. [T][X] task1
+```
 
-Describe the action and its outcome.
+### Mark task as not done: `unmark <task number>` 
+Sets a given task as not done
+```
+unmark 1
+Oh we aren't done with item 1?
+1. [T][ ] task1
+```
+
+### Create a simple todo task: `todo <task description>`
+Creates a standard todo task and adds it into the tasklist
+```
+todo task1
+Okay! I've added: [T] task1
+```
+Anna will prompt you if you forget to input the name of the task
+```
+todo
+What are you referring to?
+task1
+Okay! I've added: [T] task1
+```
+### Create a task with a deadline: `deadline <task description> /by <duedate>`  
+Creates a task with a deadline and adds it into the tasklist
+```
+deadline task2 /by 5 jan
+Okay! I've added: [D] task2
+```
+Anna will prompt you for the deadline if it is missing
+```
+deadline task2
+When is this due by?
+5 jan
+Okay! I've added: [D] task2
+```
+### Create a task with start and end dates:<br/>`event <task description> /from <startdate> /to <enddate>` 
+Creates a task with start and end times and adds it into the tasklist
+```
+event task3 /from today /to tomorrow
+Okay! I've added: [E] task3
+```
+Similarly to `deadline`, Anna will prompt you if you are missing date details
+```
+event task3 /to tomorrow
+When does this event start?
+today
+Okay! I've added: [E] task3
+```
+### Remove a task: `delete <task number>` 
+The given task will be deleted from the tasklist
+```
+delete 1
+Okay! I've deleted task: 1
+```
+### Loading and Saving of tasklist
+Anna also supports import/export of your tasklist in the form of a .txt file. This can be helpful if you want to refer to the tasklist in a future date!
 
-Example of usage: 
+`save` exports the current tasklist into a tasklist.txt file
+```
+save
+Successfully exported TaskList!
+Written to: C:\Users\lhyao\Desktop\TaskList.txt
+```
+`load` imports a previous tasklist into the program's tasklist <br>
+Anna looks for a `TaskList.txt` file in the same directory to import from
+```
+load
+Okay! I've added: [D] task2
+Okay! I've added: [D] task2
+Okay! I've added: [E] task3
+Okay! I've added: [E] task3
+Okay! I've added: [T] task1
+```
+## Usage Example
 
-`keyword (optional arguments)`
+#### Input Example 1
+`deadline ip /by tonight`
 
-Expected outcome:
+#### Expected Output 1
+`Okay! I've added: [D] ip`
 
-Description of the outcome.
+#### Input Example 2
+`list`
 
+#### Expected Output 2
 ```
-expected output
-```
+Here's what we've gotta do:
+1. [D][ ] ip 
+    Deadline: tonight
+We currently have 1 tasks
+```