[kristianachwan] iP

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# duke.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.
 
@@ -13,7 +13,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    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:
+3. After that, locate the `src/main/java/duke.Duke.java` file, right-click it, and choose `Run duke.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
     ____        _        

data/duke.txt

@@ -0,0 +1,2 @@
+	  1. [D][ ]	tP Meeting (by: Friday 16.00pm)
+	  2. [E][ ]	CS2113 tP Meeting (from: Friday 16.00pm to: 18.00pm)

docs/README.md

@@ -1,29 +1,143 @@
 # User Guide
 
-## Features 
+Duke is a Command-Line Interface (CLI) task manager. It allows you to keep track of your tasks quickly and navigate
+through those tasks quickly.
 
-### Feature-ABC
+## Features
 
-Description of the feature.
+- Adding different types of tasks:
+    - Todo: the most basic type of task
+    - Deadline: type of task which you can assign the due date of it
+    - Event: type of task which has a start and end date
+- Searching based on keyword and listing all tasks are also supported
 
-### Feature-XYZ
+## Getting started
 
-Description of the feature.
+> Java 11 is recommended to run `Duke`
 
-## Usage
+1. Download the latest ip.jar from [here](https://github.com/kristianachwan/ip/releases)
+2. Go to the directory where you downloaded
+3. Run `java -jar ip.jar`
 
-### `Keyword` - Describe action
+## Add ToDo
 
-Describe the action and its outcome.
+Adds todo to your list. Format: `todo <todo-name>`
 
-Example of usage: 
+### Adding `ToDo` example:
 
-`keyword (optional arguments)`
+```
+todo CS2113 tP Meeting
+    ____________________________________________________________
+    Got it. I've added this task:
+    [T][ ]	CS2113 tP Meeting
+    ____________________________________________________________
+```
+
+## Add Deadline
+
+Adds deadline to your list. Format: `deadline <deadline-name> /<due-by>`
+
+### Adding `Deadline` example:
+
+```
+deadline tP Meeting /Friday 16.00pm
+    ____________________________________________________________
+    Got it. I've added this task:
+    [D][ ]	tP Meeting (by: Friday 16.00pm)
+    ____________________________________________________________
+```
+
+## Add Deadline
+
+Adds event to your list. Format: `event <event-name> /<start-time> /<end-time> `
+
+### Adding `Event` example:
+
+```
+event CS2113 tP Meeting /Friday 16.00pm /18.00pm
+    ____________________________________________________________
+    Got it. I've added this task:
+    [E][ ]	CS2113 tP Meeting (from: Friday 16.00pm to: 18.00pm)
+    ____________________________________________________________
+
+```
+
+### Listing all tasks
+
+List all of your tasks. Format: `list`
+
+### Listing all tasks example:
+
+```
+list
+    ____________________________________________________________
+      1. [T][ ]	CS2113 tP Meeting
+      2. [D][ ]	tP Meeting (by: Friday 16.00pm)
+      3. [E][ ]	CS2113 tP Meeting (from: Friday 16.00pm to: 18.00pm)
+    ____________________________________________________________
+```
 
-Expected outcome:
+## Deleting a task:
 
-Description of the outcome.
+Delete your task by indicate the index of the task. Format: `delete <task-index>`
 
+### Deleting a task example:
+
+```
+delete 1
+    ____________________________________________________________
+    Noted! I've removed this task
+    [T][ ]	CS2113 tP Meeting
+    ____________________________________________________________
 ```
-expected output
+
+## Finding specific tasks
+
+Find your task based on specific keyword. Format: `find <keyword>`
+
+### Finding specific tasks example
+
+```
+find tP
+    ____________________________________________________________
+    [D][ ]	tP Meeting (by: Friday 16.00pm)
+    [E][ ]	CS2113 tP Meeting (from: Friday 16.00pm to: 18.00pm)
+    ____________________________________________________________
+```
+
+## Marking task as done
+
+Mark your task as done. It will have `[X]` when it is listed again.
+Format: `mark <task-index>`
+
+### Marking task as done example
+
+```
+mark 1 
+    ____________________________________________________________
+    Nice! I've marked this task as done:
+    [D][X]	tP Meeting (by: Friday 16.00pm)
+    ____________________________________________________________
+```
+
+### Marking task as undone
+
+Mark your task as undone (or unmark). It will revert back to `[]`.
+Format: `unmark <task-index>`
+
+```
+unmark 1
+    ____________________________________________________________
+    Ok, I've marked this task as not done:
+    [D][ ]	tP Meeting (by: Friday 16.00pm)
+    ____________________________________________________________
+```
+
+### Exiting the program
+
 ```
+bye
+    ____________________________________________________________
+    Bye. Hope to see you again soon!
+    ____________________________________________________________
+```

duke.txt

@@ -0,0 +1,5 @@
+	  1. [T][ ]	asd1
+	  2. [T][ ]	asd23
+	  3. [T][ ]	asd33
+	  4. [T][ ]	a
+	  5. [D][ ]	asd (by: 2pm)

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

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: duke.Duke
+

src/main/java/duke/Duke.java

@@ -0,0 +1,32 @@
+package duke;
+
+import duke.boundary.Ui;
+import duke.controller.TaskList;
+import duke.model.Command;
+import duke.utils.Parser;
+import duke.utils.Storage;
+
+import java.util.Scanner;
+
+/**
+ * A class that serves as an entry point to the application
+ */
+public class Duke {
+    public static void main(String[] args) {
+        Storage dataAccess = new Storage("duke.txt");
+        Scanner scanner = new Scanner(System.in);
+        TaskList taskList = new TaskList();
+        Ui ui = new Ui(taskList);
+        ui.printDuke();
+        String input;
+        while (true) {
+            input = scanner.nextLine();
+            Command command = Parser.parse(input);
+            ui.readCommand(command);
+            dataAccess.writeToFile("\t" + taskList.toString());
+        }
+
+    }
+
+
+}