Skip to content

Commit

Permalink
Fix formatting issues in UG
Browse files Browse the repository at this point in the history
  • Loading branch information
ningtan11 committed Sep 14, 2022
1 parent 8c61edc commit 9a28176
Showing 1 changed file with 32 additions and 32 deletions.
64 changes: 32 additions & 32 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Hello, Master, I'm Duke, your new virtual servant. If you're feeling overwhelmed
- A friendly and unassuming personality
- The ability to remember your tasks indefinitely... until you decide that I shouldn't
- A flexible way to keep track of dates and times
- Coffee :coffee:
- Coffee

### Personality
Welcoming from the get-go and your servant through-and-through. Can I make you a cuppa?
Expand All @@ -26,13 +26,11 @@ Would you like a cup of coffee, Master?
### `Todo` - adds 'todo' item
A task without a due date will be added to your list.

Example of usage:

**Example of usage:**
`todo eat apple`

Expected outcome:

A task named 'eat apple' will be added to your list.
**Expected outcome:**
A task named `eat apple` will be added to your list.

```
I have added [T][ ] eat apple to the list, Master
Expand All @@ -41,12 +39,10 @@ I have added [T][ ] eat apple to the list, Master
### `Deadline` - adds 'deadline' item
A task with a due date will be added to your list.

Example of usage:

**Example of usage: **
`deadline eat apple /by 7pm`

Expected outcome:

**Expected outcome:**
A task named 'eat apple' with the deadline '7pm' will be added to your list.

```
Expand All @@ -56,12 +52,10 @@ I have added [D][ ] eat apple (by: 7pm) to the list, Master
### `Event` - adds 'event' item
A task with date will be added to your list.

Example of usage:

**Example of usage: **
`event party /on 2022-07-10`

Expected outcome:

**Expected outcome:**
An event named 'party' with the date '7pm' will be added to your list.

```
Expand All @@ -71,10 +65,10 @@ I have added [E][ ] party (on: Jul 10 2022) to the list, Master
### `Mark` - marks an undone task as done
The specified task will be marked as done.

Example of usage:
**Example of usage:**
`mark 1`

Expected outcome:
**Expected outcome:**
The first task on your list will be marked as done.

```
Expand All @@ -84,10 +78,10 @@ Well done, Master! I have marked [T][X] eat apple as done.
### `Unmark` - marks a done task as undone
The specified task will be marked undone.

Example of usage:
**Example of usage:**
`unmark 1`

Expected outcome:
**Expected outcome:**
The first task on your list will be marked as undone.

```
Expand All @@ -97,10 +91,11 @@ Oh no :( I have marked [T][ ] eat apple as undone, Master.
### `Delete` - removes task
The specified task will be removed from your list.

Example of usage:
**Example of usage:**
`delete 1`

Expected outcome: the first task on your list will be removed.
**Expected outcome:**
The first task on your list will be removed.

```
Very well. I have deleted [T][ ] eat apple from your list, master.
Expand All @@ -109,39 +104,43 @@ Very well. I have deleted [T][ ] eat apple from your list, master.
### `Edit` - edits task
The name or date/time of the specified task will be edited.

Example of usage:
**Example of usage:**
`edit 1 sleep`

Expected outcome: the name of the first task on your list will be changed to `sleep`
**Expected outcome:**
The name of the first task on your list will be changed to `sleep`

```
I have edited task 1 to [D][ ] sleep (by: 7pm), Master.
```

Example of usage:
**Example of usage:**
`edit 1 deadline 12am`

Expected outcome: the deadline of the first task on your list will be changed to `12am`
**Expected outcome:**
The deadline of the first task on your list will be changed to `12am`

```
I have edited task 1 to [D][ ] sleep (by: 12am), Master.
```

Example of usage:
**Example of usage:**
`edit 2 time 2022-07-11`

Expected outcome: the deadline of the first task on your list will be changed to July 11 2022
**Expected outcome:**
The deadline of the first task on your list will be changed to July 11 2022

```
I have edited task 2 to [E][ ] party (on: Jul 11 2022), Master.
```

### `List` - displays your task list

Example of usage:
**Example of usage:**
`list`

Expected outcome: your task list
**Expected outcome:**
Your task list will be displayed.

```
Here is your to-do list, Master:
Expand All @@ -152,10 +151,11 @@ Here is your to-do list, Master:
### `Find` - finds task
The subset of your task list that matches the specified keyword(s) will be displayed.

Example of usage:
**Example of usage:**
`find party`

Expected outcome: all tasks that contain the word 'party'
**Expected outcome:**
A list of all your tasks that contain the word 'party' will be displayed.

```
I have found the following task matching "party":
Expand All @@ -164,7 +164,7 @@ I have found the following task matching "party":

### `Coffee` - makes you a cup of coffee

Example of usage:
**Example of usage:**
`coffee`

```
Expand All @@ -174,7 +174,7 @@ I have prepared a steaming cup of coffee for you, Master. Enjoy it while it's ho
### `Bye` - saves your task list
Your task list be saved, and the old save will be overwritten.

Example of usage:
**Example of usage:**
`bye`

```
Expand Down

0 comments on commit 9a28176

Please sign in to comment.