Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterHW963 authored Sep 19, 2024
1 parent f17eea0 commit a6903a2
Showing 1 changed file with 117 additions and 7 deletions.
124 changes: 117 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ experience that feels natural and straightforward.
- [Add a Deadline Task: `deadline`](#add-a-deadline-task-deadline)
- [Add an Event Task: `event`](#add-an-event-task-event)
- [Mark a Task: `mark`, `unmark`](#mark-a-task-mark-unmark)
- [List Out Tasks: `list`](#list-out-tasks-list)
- [Find a Task: `find`](#find-a-task-find)
- [Delete a Task: `delete`](#delete-a-task-delete)
- [List Out Tasks: `list`](#list-out-tasks-list)
- [Tagging: `#`](#tagging-)
- [Miscellaneous Commands: `nether`, `bye`](#miscellaneous-commands-nether-bye)
- [Known Issues](#known-issues)
Expand All @@ -37,6 +37,9 @@ Adds a `todo` task to the task list.

Format: `todo (description) [#tag]`

> [!NOTE]
> `#tag` is an optional part of the command. Learn more about how to add tags to your tasks [here](#tagging-)
Example input:
`todo Read Book`

Expand All @@ -52,34 +55,141 @@ Adds a `deadline` task to the task list.

Format: `deadline (description) [#tag] /by (time)`

> :exclamation:
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> The only acceptable time format is `yyyy-MM-dd HHmm`
> e.g. `2024-09-19-2359`
Example input: `deadline Submit CS2103T Assignment /by 2024-09-20 2359`

Expected output:
```
Got it. I've added this task:
[D][ ] Submit CS2103T Assignment (by: Sep 20 2024, 11:59pm)
```

## Add an Event Task: `event`

Adds an `event` task to the task list.

Format: `event (description) [#tag] /from (time) /to (time)`

Example input: `event Festival /from 2024-09-01 0700 /to 2024-09-03 1900`

Expected output:
```
Got it. I've added this task:
[E][ ] Festival (from: Sep 1 2024, 7:00am to: Sep 03 2024, 7:00pm)
```

## Mark a Task: `mark`, `unmark`

Mark your task as done or not done using `mark` and `unmark` respectively.

### Mark a task as done: `mark`
Format: `mark (task number)`

Example input: `mark 3`

Expected output:
```
Well done! I've marked this task as done:
[E][X] Festival (from: Sep 1 2024, 7:00am to: Sep 03 2024, 7:00pm)
```

### Mark a task as not done: `unmark`
Format `unmark (task number)`

Example input: `unmark 3`

Expected output:
```
Understood, I've marked this task as not done:
[E][ ] Festival (from: Sep 1 2024, 7:00am to: Sep 03 2024, 7:00pm)
```

## List Out Tasks: `list`
List out all the tasks you have in your task list.

Format: `list`

Example input: `list`

Expected output:
```
Here are the tasks in your list:
1. [T][ ] Read Book
2. [D][ ] Submit CS2103T Assignment (by: Sep 20 2024, 11:59pm)
3. [E][ ] Festival (from: Sep 1 2024, 7:00am to: Sep 03 2024, 7:00pm)
```

## Find a Task: `find`
Find all tasks that contain the input search keyword (not case sensitive).

Format: `find (keyword)`

Example input: `find book`

Expected output:
```
Here are the tasks that match your search in your list:
1. [T][ ] Read Book
```

## Delete a Task: `delete`
Delete a task from your task list.

## List Out Tasks: `list`
Format: `delete (task number)`

Example input: `delete 1`

Expected output:
```
Noted, I've removed this task from the list:
[T][ ] Read Book
Now you have 2 tasks in the list.
```

## Tagging: `#`
Tag or find your tasks using `#`.

## Miscellaneous Commands: `nether`, `bye`
### Add tasks with a tag

Format: `(type) (description) [#tag] [time for deadline or event task]`

Example input: `deadline Do Laundry #Chores /by 2024-09-20 0600`

Expected output:
```
Got it. I've added this task:
[D][ ] <Chores> Do Laundry (by: Sep 20 2024, 6:00am)
```

### Find tasks with a tag

List out all the tasks that contain the searched tag.

Format: `find (tag)`

Example input: `find #chores`

Expected output:
```
Here are the tasks that match your search in your list:
1. [D][ ] <Chores> Do Laundry (by: Sep 20 2024, 6:00am)
```

## Miscellaneous Commands: `nether`, `bye`

// Details of this feature

___
# Known Issues
___

// Feature details
// Known issues for Nether


# Command Summary
___

// Feature details
// Feature details

0 comments on commit a6903a2

Please sign in to comment.