[Yeon Jeho] iP

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+/data/
+/text-ui-test/data/

README.md

@@ -1,24 +1,61 @@
-# 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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# Nuke User Guide
+Nuke is a desktop app for managing tasks using CLI (Command Line Interface).
+
+
+## Features
+
+
+### Exiting: `bye`
+
+Exits program while saving the tasks on the file system.
+
+Format: `bye`
+
+### Adding a task: `todo`
+
+Adds a task to the list.
+
+Format: `todo <NAME>`
+
+### Adding a task with a deadline: `deadline`
+
+Adds a task with a deadline to the list.
+
+Format: `deadline <NAME> /by <DEADLINE>`
+
+### Adding an event: `event`
+
+Adds an event to the list.
+
+Format: `event <NAME> /from <START> /to <END>`
+
+### Viewing all tasks: `list`
+
+Shows a list of tasks in the list.
+
+Format: `list`
+
+### Marking a task as done: `mark`
+
+Marks a task as done.
+
+Format: `mark <INDEX>`
+
+### Marking a task as not done: `unmark`
+
+Marks a task as not done.
+
+Format: `unmark <INDEX>`
+
+### Deleting a task: `delete`
+
+Deletes a task in the list.
+
+Format: `delete <INDEX>`
+
+### Finding a task by keyword: `find`
+
+Finds a task in the list by a keyword.
+
+Format: `find <KEYWORD>`
+

docs/README.md

@@ -1,29 +1,198 @@
 # User Guide
+Nuke is a desktop app for managing tasks using CLI (Command Line Interface).
 
 ## Features 
 
-### Feature-ABC
+### Exiting: `bye`
 
-Description of the feature.
+Exits program while saving the tasks on the file system.
 
-### Feature-XYZ
+### Adding a task: `todo`
+
+Adds a task to the list.
+
+### Adding a task with a deadline: `deadline`
+
+Adds a task with a deadline to the list.
+
+### Adding an event: `event`
+
+Adds an event to the list.
+
+### Viewing all tasks: `list`
+
+Shows a list of tasks in the list.
+
+### Marking a task as done: `mark`
+
+Marks a task as done.
+
+### Marking a task as not done: `unmark`
+
+Marks a task as not done.
+
+### Deleting a task: `delete`
+
+Deletes a task in the list.
+
+### Finding a task by keyword: `find`
+
+Finds a task in the list by a keyword.
 
-Description of the feature.
 
 ## Usage
 
-### `Keyword` - Describe action
+### `bye` - Exits program
+
+Exits program while saving the tasks on the file system.
+
+Example of usage:
+
+`bye`
+
+Expected outcome:
+
+```
+[@] Bye. Hope to see you again soon!
+```
+
+### `todo` - Adds a task
+
+Adds a task to the list.
+
+Example of usage:
+
+`todo <NAME>`
+
+Expected outcome:
+
+If input is `todo read book`,
+
+```
+[@] Got it. I've added this task:
+  [T][ ] read book
+[@] Now you have 1 task in the list.
+```
+
+### `deadline` - Adds a task with a deadline
+
+Adds a task with a deadline to the list.
+
+Example of usage:
+
+`deadline <NAME> /by <DEADLINE>`
+
+Expected outcome:
+
+If input is `deadline return book /by June 6th`,
+
+```
+[@] Got it. I've added this task:
+  [D][ ] return book (by: June 6th)
+[@] Now you have 2 tasks in the list.
+```
+
+### `event` - Adds an event
+
+Adds an event to the list.
+
+Example of usage:
+
+`event <NAME> /from <START> /to <END>`
+
+Expected outcome:
+
+If input is `event project meeting /from Aug 6th 2pm /to 4pm`,
+
+```
+[@] Got it. I've added this task:
+  [E][ ] project meeting (from: Aug 6th 2pm to: 4pm)
+[@] Now you have 3 tasks in the list.
+```
+
+### `list` - Views all tasks
+
+Shows a list of tasks in the list.
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+```
+[@] Here are the tasks in your list:
+1.[T][ ] read book
+2.[D][ ] return book (by: June 6th)
+3.[E][ ] project meeting (from: Aug 6th 2pm to: 4pm)
+```
+
+### `mark` - Marks a task as done
+
+Marks a task as done.
+
+Example of usage:
+
+`mark <INDEX>`
+
+Expected outcome:
+
+If input is `mark 1`,
+
+```
+[@] Nice! I've marked this task as done:
+  [T][X] read book
+```
+
+### `unmark` - Marks a task as not done
+
+Marks a task as not done.
+
+Example of usage:
+
+`unmark <INDEX>`
+
+Expected outcome:
+
+If input is `unmark 3`,
+
+```
+[@] OK, I've marked this task as not done yet:
+  [E][ ] project meeting (from: Aug 6th 2pm to: 4pm)
+```
+
+### `delete` - Deletes a task
+
+Deletes a task in the list.
+
+Example of usage:
+
+`delete <INDEX>`
+
+Expected outcome:
+
+If input is `delete 3`,
+
+```
+[@] Noted. I've removed this task:
+  [E][ ] project meeting (from: Aug 6th 2pm to: 4pm)
+[@] Now you have 2 tasks in the list.
+```
+
+### `find` - Finds a task by keyword
 
-Describe the action and its outcome.
+Finds a task in the list by a keyword.
 
-Example of usage: 
+Example of usage:
 
-`keyword (optional arguments)`
+`find <KEYWORD>`
 
 Expected outcome:
 
-Description of the outcome.
+If input is `find book`,
 
 ```
-expected output
+[@] Here are the matching tasks in your list:
+1.[T][X] read book
+2.[D][ ] return book (by: June 6th)
 ```

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

@@ -0,0 +1,3 @@
+Manifest-Version: 0.1
+Main-Class: nuke.Nuke
+