Skip to content

Commit

Permalink
Set up user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
wltan committed Sep 14, 2020
1 parent 058af5a commit afaabc4
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 10 deletions.
72 changes: 62 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,72 @@
# User Guide
# iPbot User Guide

![Screenshot](Ui.png)

## Features
### `todo` - Creates a new Todo task

Adds a new Todo task. A Todo task only has a description attached.

Usage: `todo <Task Description>`

Expected output: An acknowledgement that iPbot has added the task.

### `event` - Creates a new Event task

Adds a new Event task. An Event task has both a description and an event time.

Usage: `event <Task Description> /at <Event Time>`

Expected output: An acknowledgement that iPbot has added the task.

### `deadline` - Creates a new Deadline task

Adds a new Deadline task. A Deadline task has both a description and a time due.

Usage: `deadline <Task Description> /by <Time Due>`

Expected output: An acknowledgement that iPbot has added the task.

### `list` - Lists all tasks

Retrieves all tasks in the task list and displays them.
Note that iPbot always displays the latest task list on the right.

Usage: `list`

Expected output: The list of tasks

### `done` - Marks a task as done

Marks the task with a given ID as done. The task ID refers to the numbering in the task list.
If the task was already marked as done, iPbot will report that in its output.

Usage: `done <Task ID>`

Expected output: An acknowledgement that the task was completed.

### `bye` - Exits from iPbot

Immediately closes iPbot.

Usage: `bye`

Expected output: The application exits.

### Feature 1
Description of feature.
### `load` - Loads commands from a file

## Usage
Silently loads a script of commands from an external file.
This can be the saved data file from another instance of iPbot.

### `Keyword` - Describe action
Usage: `load <File Location>`

Describe action and its outcome.
Expected output: The application exits.

Example of usage:
### `help` - Displays help message

`keyword (optional arguments)`
Displays a list of available commands.
Note that iPbot always displays this command list on the left.

Expected outcome:
Usage: `help`

`outcome`
Expected output: A list of available commands.
Binary file added docs/Ui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit afaabc4

Please sign in to comment.