Skip to content

Commit e32b0ae

Browse files
committed
Update README.md
1 parent 9215837 commit e32b0ae

File tree

1 file changed

+62
-4
lines changed

1 file changed

+62
-4
lines changed

docs/README.md

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ BadGPT is a **desktop app for managing your tasks**.
1010
5. Type the command in the command box and press Enter to execute it. Here are some example commands to get you started:
1111
- `list`: Lists all tasks.
1212
- `todo return book`: Adds a todo task with the description return book.
13-
- `mark 2`: Marks the 2nd task in the list as complete.
1413
- `deadline homework /by 2024-02-23`: Adds a deadline task with the description homework and the deadline 23 Feb 2024.
15-
- `delete 3`: Deletes the 3rd task in the list.
14+
- `mark 2`: Marks the 2nd task in the list as complete.
15+
- `delete 2`: Deletes the 2nd task in the list.
1616
- `bye`: Exits the app.
1717
6. Refer to the Features below for details of each command.
1818

@@ -22,33 +22,65 @@ Lists all current tasks in the list.
2222

2323
Format: `list`
2424

25+
Sample output:
26+
```
27+
1. [T][ ] return book
28+
2. [D][ ] submit ip (by: 23 Feb 2024)
29+
3. [E][ ] recess week (from: 24 Feb 2024 to: 3 Mar 2024)
30+
4. [T][ ] borrow book
31+
```
32+
2533
### Marking task as complete: `mark`
2634
Marks the task in the specified position in the list as complete.
2735

2836
Format: `mark TASK_NUMBER`
2937

3038
Example: `mark 2`
3139

40+
Sample output:
41+
```
42+
Nice! I've marked this task as done:
43+
[D][X] submit ip (by: 23 Feb 2024)
44+
```
45+
3246
### Marking task as incomplete: `unmark`
3347
Marks the task in the specified position in the list as incomplete.
3448

3549
Format: `unmark TASK_NUMBER`
3650

3751
Example: `unmark 2`
3852

53+
Sample output:
54+
```
55+
wyd bro why undo
56+
[D][ ] submit ip (by: 23 Feb 2024)
57+
```
58+
3959
### Adding a new todo task: `todo`
4060
Adds a new todo task to the task list.
4161

4262
Format: `todo TASK_DESCRIPTION`
4363

4464
Example: `todo return book`
4565

66+
Sample output:
67+
```
68+
Added task: [T][ ] return book
69+
Now you have 5 task(s) in the list.
70+
```
71+
4672
### Adding a new deadline task: `deadline`
4773
Adds a new deadline task to the task list.
4874

4975
Format: `deadline TASK_DESCRIPTION /by YYYY-MM-DD`
5076

51-
Example: `deadline ip submission /by 2024-02-23`
77+
Example: `deadline submit ip /by 2024-02-23`
78+
79+
Sample output:
80+
```
81+
Added task: [D][ ] submit ip (by: 23 Feb 2024)
82+
Now you have 6 task(s) in the list.
83+
```
5284

5385
### Adding a new event task: `event`
5486
Adds a new event task to the task list.
@@ -57,19 +89,39 @@ Format: `event TASK_DESCRIPTION /from YYYY-MM-DD /to YYYY-MM-DD`
5789

5890
Example: `event recess week /from 2024-02-24 /to 2024-03-03`
5991

92+
Sample output:
93+
```
94+
Added task: [E][ ] recess week (from: 24 Feb 2024 to: 3 Mar 2024)
95+
Now you have 7 task(s) in the list.
96+
```
97+
6098
### Deleting a task: `delete`
6199
Deletes the task in the specified position from the task list.
62100

63101
Format: `delete TASK_NUMBER`
64102

65103
Example: `delete 3`
66104

105+
Sample output:
106+
```
107+
This task has been removed: [E][ ] recess week (from: 24 Feb 2024 to: 3 Mar 2024)
108+
Now you have 6 task(s) in the list.
109+
No, what are you waiting for? Do it! Just do it!
110+
```
111+
67112
### Filtering tasks: `find`
68113
Finds the tasks in the list which contain a specified keyword or phrase.
69114

70115
Format: `find KEYWORD`
71116

72-
Example: `find book` or `find buy groceries`
117+
Example: `find book`
118+
119+
Sample output:
120+
```
121+
Here are the tasks in your list:
122+
1. [T][ ] return book
123+
2. [T][ ] borrow book
124+
```
73125

74126
### Finding tasks by date: `date`
75127
Finds any tasks occurring before or on the specified date.
@@ -78,6 +130,12 @@ Format: `date YYYY-MM-DD`
78130

79131
Example: `date 2024-02-23`
80132

133+
Sample output:
134+
```
135+
Here are the tasks in your list:
136+
1. [D][ ] submit ip (by: 23 Feb 2024)
137+
```
138+
81139
### Exiting the program: `bye`
82140
Exits the program.
83141

0 commit comments

Comments
 (0)