Update User Guide

Jargonx · Sep 18, 2020 · 8991c7d · 8991c7d
1 parent 3c4f8ed
commit 8991c7d
Show file tree

Hide file tree

Showing 14 changed files with 135 additions and 13 deletions.
diff --git a/data/duke.txt b/data/duke.txt
@@ -1,2 +1,2 @@
-1. [T] [DONE]  something
-2. [D] [DONE]  something else (by: 2020-10-23 19:00)
+1. [T] [DONE] eat eyeholes cereal
+2. [T] [X] fix microverse car battery
diff --git a/docs/README.md b/docs/README.md
@@ -1,20 +1,142 @@
-# User Guide
+# RickBot User Guide
 
-## Features 
+A Rick and Morty themed Command Line Interface for doing To-do tasking.
 
-### Feature 1 
-Description of feature.
+## Rick Sanchez Features
 
-## Usage
+Here are the features supported by Rick:
+1. [Adding tasks in the list](#add)
+2. [Listing of tasks](#list)
+2. [Marking the tasks as DONE](#done)
+3. [Deleting tasks](#delete)
+4. [Finding a task](#find)
+5. [Help](#help)
+6. [Save Tasks](#save)
+7. [Load Tasks](#load)
 
-### `Keyword` - Describe action
+### Features
+#### 1. Adding tasks in the list <a name="add"></a>
 
-Describe action and its outcome.
+User will be able to add tasks into RickBot. There are 3 types of tasks that can be added to RickBot.
+Note that all Strings written in [SquareBrackets] are the command parameters, with specified formatting.
+##### 1. Todo <a name="addTodo"></a> - `todo [TaskName]`
+Adds a simple todo with the specified task name.
 
-Example of usage: 
-
-`keyword (optional arguments)`
+Example usage: `todo go to planet Florzon to Glop`
 
 Expected outcome:
+![image](./todo.png)
+
+##### 2. Deadline <a name="addDeadline"></a> - `deadline [TaskName] /by [DD/MM/YYYY] [HH:MM]`
+Adds a todo with a deadline with the specified task name, date and time.
+
+Example usage: `deadline go to planet Florzon to Glop /by 21/09/2020 21:30`
+
+Expected Outcome:
+![image](./deadline.png)
+
+##### 3. Event <a name="addEvent"></a> - `event [TaskName] ['/at' OR '/on'] [DD/MM/YYYY] [HH:MM]`
+Adds a todo as an occurrence, with the specified task name, date and time.
+
+Example usage: `event go to planet Florzon to Glop /at 21/09/2020 21:30`
+
+Expected Outcome:
+![image](./event.png)
+
+#### 2. Listing of tasks <a name="list"></a>
+
+User will be able to list the current tasks in the task list.
+##### `list`
+
+Example usage: `list`
+
+Expected Outcome:
+![image](./list.png)
+
+#### 3. Marking the tasks as DONE <a name="done"></a>
+
+All User added tasks will be added as uncompleted tasks. User can mark them as DONE using this command.
+##### `done [TaskListNumber]`
+The User can see what the TaskListNumber is from the [**`list`**](#list) command.
+
+Example usage: `done 1`
+
+Expected Outcome:
+![image](./done.png)
+
+#### 4. Deleting tasks <a name="delete"></a>
+
+User can delete tasks from list.
+##### `delete [TaskListNumber]`
+The User can see what the TaskListNumber is from the [**`list`**](#list) command.
+
+Example usage: `delete 1`
+
+Expected Outcome:
+![image](./delete.png)
+
+#### 5. Finding a task <a name="find"></a>
+User can find tasks in the list.
+##### `find [TaskNameSubString]`
+
+User can type in any substring that appears in the Task name, and they will be given a list of tasks with the specified substring.
+
+Example usage: `find car`
+
+Expected Outcome:
+![image](./find.png)
+
+#### 6. Help <a name="help"></a>
+Rick Sanchez may be the smartest man in the universe, so he doesn't expect Morty(the User) to remember the commands that he can say to him.
+The User may type in the `help` command to find the right command for the job.
+##### `help`
+
+Example usage: `help`
+
+Expected Outcome:
+![image](./helpAll.png)
+
+If the User wants a more detailed description of the command then they can use the following command:
+##### `help [CommandName]`
+
+Example usage: `help deadline`
+
+Expected Outcome:
+![image](./helpOne.png)
+
+Ofcourse, they can use the [**`help`**](#help) command to see the list of commands.
+
+#### 7. Save Tasks <a name="save"></a>
+User can use the following command to save the current tasks into persistent storage.
+##### `save`
+
+Example usage: `save`
+
+Expected Outcome:
+![image](./save.png)
+
+This will save the Tasks in a human readable format under the file path ip/data/duke.txt by default.
+
+All previous data in the save file(duke.txt) will be overwritten by this.
+
+#### 8. Load Tasks <a name="load"></a>
+User can use the following command to load previously stored tasks from persistent storage.
+##### `load [FilePathName]`
+
+Example usage: `load ./data/duke.txt`
+
+Expected Outcome:
+![image](./load.png)
+
+This will load the Tasks from the filePath specified. User is expected to use `./data/duke.txt` by default.
+
+User may choose to make their own task file and load it. The tasks are to follow the following format:
+
+1. [T] [X]  some todo name here
+2. [D] [X]  some deadline name here (by:  12/05/2020 14:30)
+3. [E] [X]  some event name here (at:  13/05/2020 13:30)
+
+If the tasks do not follow this format, there will be a WrongFormat Error shown to the User.
+If unsure, refer to [**`todo`**](#addTodo), [**`deadline`**](#addDeadline), [**`event`**](#addEvent).
 
-`outcome`
+Have fun talking to RickBot from Dimension B420!
diff --git a/docs/Ui.png b/docs/Ui.png
diff --git a/docs/deadline.png b/docs/deadline.png
diff --git a/docs/delete.png b/docs/delete.png
diff --git a/docs/done.png b/docs/done.png
diff --git a/docs/event.png b/docs/event.png
diff --git a/docs/find.png b/docs/find.png
diff --git a/docs/helpAll.png b/docs/helpAll.png
diff --git a/docs/helpOne.png b/docs/helpOne.png
diff --git a/docs/list.png b/docs/list.png
diff --git a/docs/load.png b/docs/load.png
diff --git a/docs/save.png b/docs/save.png
diff --git a/docs/todo.png b/docs/todo.png