Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Leb14 authored Sep 20, 2023
1 parent 892e19a commit 284383f
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,19 @@ Removes tasks from your task list when they are no longer relevant or needed.
Displays all the tasks in the task list.

- Format: `list`

- Example:

![Local Image](./assets/images/list.png)

- The task display in this format: [Type][Completeness] Task description
- **Type**:
- `[T]` = `todo`
- `[E]` = `event`
- `[D]` = `deadline`
- **Completeness**:
- `[X]` = `done`
- `[ ]` = `not done`

### Edit a task: `edit`

Expand All @@ -68,12 +80,12 @@ Edits a task field to a new input
- The INDEX must be a positive integer 1,2,3 ...
- FIELD must be provided in lowercase.
- Here are the respective FIELDs for each type of task:
- To-do: taskdesc
- Events: taskdesc, fromdate, todate
- Deadlines: taskdesc, duedate
- `todo`: `taskdesc`
- `event`: `taskdesc`, `fromdate`, `todate`
- `deadline`: `taskdesc`, `duedate`
- The provided NEWINPUT must match the format for the provided FIELD.

e.g If FIELD = fromdate, then NEWINPUT = 23/08/2023 1800
e.g If FIELD = `fromdate`, then NEWINPUT = `23/08/2023 1800`

- Example:

Expand All @@ -92,6 +104,8 @@ Marks a task as completed.

- Example:
- `mark 1`, Mark the first task of the list as done.

![Local Image](./assets/images/mark.png)


### Mark not done -`unmark`
Expand All @@ -103,6 +117,8 @@ Marks a task as not complete.

- Example:
- `unmark 1` Mark the first task of the list as not done.

![Local Image](./assets/images/unmark.png)


### Find a task - `find`
Expand Down

0 comments on commit 284383f

Please sign in to comment.