Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/urieltan/ip
Browse files Browse the repository at this point in the history
  • Loading branch information
urieltan committed Sep 16, 2020
2 parents 5027aff + c4d74ae commit 0d38808
Show file tree
Hide file tree
Showing 2 changed files with 144 additions and 8 deletions.
152 changes: 144 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,156 @@
# User Guide
# Duke User Guide
This is a regular Duke (Todo list app) with only 1 feature (C-MassOps).
Basic Ui only.
## Sneakpeak
<img src="https://github.com/urieltan/ip/blob/master/docs/Ui.png?raw=true" style="
width: 30%;
height: 30%;">

## Features

### Feature 1
Description of feature.
### Mass operations
Able to remove multiple tasks at once, and set multiple tasks to done.

## Usage

### `Keyword` - Describe action
### `list` - list all tasks

Describe action and its outcome.
Shows a list of all tasks.

Example of usage:

`keyword (optional arguments)`
`list`

Expected outcome:<br />
```
1. [D] [✓] Buy eggs (by: 7pm)
2. [T] [✗] Sell eggs
```

### `todo [description]` - Add a basic task
Add a task.

Example of usage:

`todo buy some eggs`

Expected outcome:<br />
```
Got it, I've added this task:
[T] [✗] buy some eggs
```

### `event [description] /at [YYYY/MM/DD]` - Add a task with a time
Add a event.

Example of usage:

`event buy some bananas /at 2020/01/01`

Expected outcome:<br />
```
Got it, I've added this task:
[E] [✗] buy some bananas (at: Jan 1 2020)
```


### `deadline [description] /at [YYYY/MM/DD]` - Add a task with a deadline
Add a deadline.

Example of usage:

`deadline buy some ham /by 2020/02/02`

Expected outcome:<br />
```
Got it, I've added this task:
[D] [✗] buy some ham (at: Feb 2 2020)
```



### `remove [index]` - Remove task
Remove task at a particular index.

Example of usage:

`remove 3`

Expected outcome:<br />
```
Noted. I've removed the tasks:
[T] [✗] buy some eggs
Now you have 2 tasks in the list
```


### `remove [index1] [index2]...` - Remove multiple tasks
Remove tasks at the indexes

Example of usage:

`remove 3 4`

Expected outcome:<br />
```
Noted. I've removed the tasks:
[E] [✗] buy some bananas (at: Jan 1 2020)
[D] [✗] buy some ham (by: Feb 2 2020)
Now you have 2 tasks in the list
```


### `done [index]` - Set task as done
Set task at [index] as done

Example of usage:

`done 1`

Expected outcome:<br />
```
Nice! I've marked these tasks as done:
[T] [✓] buy some eggs
```


### `done [index1] [index2]` - Set multiple tasks as done
Set task at [index1],[index2]... ,as done

Example of usage:

`done 1 2`

Expected outcome:<br />
```
Nice! I've marked these tasks as done:
[T] [✓] buy some eggs
[E] [✓] buy some ham (at: Jan 1 2020)
```

### `find [search string]` - find all tasks

Shows a list of all tasks with the substring [search string]

Example of usage:

`find eggs e`

Expected outcome:<br />
```
1. [D] [✓] Buy eggs extract (by: 7pm)
2. [T] [✗] Sell eggs egger
```

### `bye` - close the program
Exit the program.

Example of usage:

`bye`

Expected outcome:<br />
Program exits.


Expected outcome:

`outcome`
Binary file added docs/Ui.png
Loading
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 0d38808

Please sign in to comment.