Skip to content

Commit

Permalink
Add user guide for earl
Browse files Browse the repository at this point in the history
  • Loading branch information
yisiox committed Feb 16, 2024
1 parent 01a1836 commit 63a7f85
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ bin/

/text-ui-test/ACTUAL.TXT
text-ui-test/EXPECTED-UNIX.TXT
/text-ui-test/data/
/data/
57 changes: 49 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ applications.

## Features

### Adding ToDos
### Adding ToDos: `todo`
Adds a todo to the list of tasks.

Format: `todo <task name>`
Expand All @@ -20,7 +20,7 @@ Example: `todo homework`, `todo wash clothes`
*Notes*
+ `<task name>` cannot be empty

### Adding Deadlines
### Adding Deadlines: `deadline`

Adds a deadline to the list of tasks.

Expand All @@ -32,7 +32,7 @@ Example: `deadline project submission /by 01/01/2024 2359`
+ `<task name>` cannot be empty.
+ `<date time>` must be of the format `dd/mm/yyyy hhmm`

### Adding Events
### Adding Events: `event`

Adds an event to the list of tasks.

Expand All @@ -44,28 +44,69 @@ Example: `event exam /from 01/01/2024 1200 /to 01/01/2024 1400`
+ `<task name>` cannot be empty.
+ `<date time>` must be of the format `dd/mm/yyyy hhmm`

### List
### Listing Tasks: `list`

Displays all tasks currently tracked.

Format: `list`

### Find
### Finding Tasks: `find`

Displays all tasks with details matching a pattern.

Format: `find <pattern>`

Example: `find wash clothes`

### Mark
### Marking Tasks: `mark`

Marks a task as complete.

Format: `mark <index or range> [<index or range>, ...] `
Format: `mark <indice> [<indices>, ...] `

Example: `mark 1 3-5`

*Notes*
+ Arguments are space separated single indices or ranges
+ Ranges must be of the form `<index>-<index>`
+ Ranges must be of the form `<index>-<index>`
+ Tasks already marked as done are unchanged
+ Indices outside the range of valid indices are ignored
+ There must be at least 1 valid index

### Unmarking Tasks: `unmark`

Marks a task as incomplete.

Format: `unmark <indices> [<indices>, ...]`

Example: `unmark 2-4 6 8-11`

*Notes*
+ Arguments are space separated single indices or ranges
+ Ranges must be of the form `<index>-<index>`
+ Tasks already marked as undone are unchanged
+ Indices outside the range of valid indices are ignored
+ There must be at least 1 valid index

### Deleting Tasks: `delete`

Removes a task from the list.

Format: `delete <indices> [<indices>, ...]`

Example: `delete 3 5 9-11`

*Notes*
+ Arguments are space separated single indices or ranges
+ Ranges must be of the form `<index>-<index>`
+ Indices outside the range of valid indices are ignored
+ There must be at least 1 valid index

### Closing the Application: `bye`

Saves the tasks and closes the application.

Format: `bye`

*Notes*
+ This is equivalent to pressing the cross on the GUI

0 comments on commit 63a7f85

Please sign in to comment.