Skip to content

Commit 61238a1

Browse files
authored
Update README.md
1 parent 1f6fad0 commit 61238a1

File tree

1 file changed

+88
-16
lines changed

1 file changed

+88
-16
lines changed

docs/README.md

Lines changed: 88 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,102 @@
1-
# Duke User Guide
1+
# Gloqi User Guide
22

3-
// Update the title above to match the actual product name
3+
Gloqi is a task‑manager chatbot that reads text commands, executes them, and stores tasks such as Todos, Deadlines, and Events.
4+
On startup it shows a data‑loading message followed by a greeting before accepting commands.
5+
![Mambo ChatBot Interface](https://guogangquan.github.io/ip/Ui.png)
46

5-
// Product screenshot goes here
7+
> [!NOTE] Notes about command format:
8+
> * Command are case insensitive.
9+
> * Argument keywords such as "/by" "/from" "/to" are case sensitive
10+
> * Items in square brackets [] are optional.</br>
11+
> e.g delete <task_number>[,<task_number>...] can be used as ```delete 1,2``` or ```delete 1```
12+
> * Items in arrow brackets <> are must to have.</br>
13+
> e.g unmark <task_number> must have item <task_number>
614
7-
// Product intro goes here
15+
## :scroll: Quick Command Overview
16+
1. list — Display all tasks in a numbered list.</br>
17+
Format: ```list```
18+
2. todo — Create a Todo task with a description.</br>
19+
Format: ```todo <description>```
20+
3. deadline — Create a Deadline task with a description and a /by date-time.</br>
21+
Format: ```deadline <description> /by <yyyy-MM-dd HHmm>```
22+
4. event — Create an Event task with a description, /from start and /to end date-times.</br>
23+
Format: ```event <description> /from <yyyy-MM-dd HHmm> /to <yyyy-MM-dd HHmm>```
24+
5. mark — Mark the specified task number as done.</br>
25+
Format: ```mark <task_number>```
26+
6. unmark — Mark the specified task number as not done.</br>
27+
Format: ```unmark <task_number>```
28+
7. delete — Delete the specified task number(s).</br>
29+
Format: ```delete <task_number>[,<task_number>...]```
30+
8. show — List tasks that fall on a given date.</br>
31+
Format: ```show <yyyy-MM-dd>```
32+
9. find — Search tasks whose descriptions contain a keyword or phrase.</br>
33+
Format: ```find <keyword or phrase>```
34+
10. bye — Print the farewell message and exit.</br>
35+
Format: ```bye```
836

9-
## Adding deadlines
37+
## :notebook_with_decorative_cover:Detail Commands Description
38+
### 1. List task: ```list```
39+
---
40+
Format: ```list```
1041

11-
// Describe the action and its outcome.
42+
Example: ```list```
43+
### 2. Add todo task: ```todo```
44+
---
45+
Format: ```todo <description>```
1246

13-
// Give examples of usage
47+
Example: ```todo Assignment 3```
48+
### 3. Add deadline task: ```deadline```
49+
---
50+
Format: ```deadline <description> /by <yyyy-MM-dd HHmm>```
1451

15-
Example: `keyword (optional arguments)`
52+
Example: ```deadline Assignment 3 /by 2025-09-25 1800```
53+
### 4. Add event task: ```event```
54+
---
55+
Format: ```event <description> /from <yyyy-MM-dd HHmm> /to <yyyy-MM-dd HHmm>```
1656

17-
// A description of the expected outcome goes here
57+
Example: ```event Lecture 3 /from 2025-09-25 1800 /to 2025-09-25 2000```
58+
### 5. Mark task: ```mark```
59+
---
60+
Format: ```mark <task_number>```
1861

19-
```
20-
expected output
21-
```
62+
Example: ```mark 3```
63+
### 6. Unmark task: ```unmark```
64+
---
65+
Format: ```unmark <task_number>```
2266

23-
## Feature ABC
67+
Example: ```unmark 3```
68+
### 7. delete task(s): ```delete```
69+
---
70+
Format: ```delete <task_number>[,<task_number>...]```
2471

25-
// Feature details
72+
Example:
73+
* Single task deletion: ```delete 1```
74+
* Mass task deletion: ```delete 1,2,5,6```
75+
### 8. Filter task base on date: ```show```
76+
---
77+
Format: ```show <yyyy-MM-dd>```
2678

79+
Example: ```show 2025-09-25```
80+
### 9. Filter task base on task description: ```find```
81+
---
82+
Format: ```find <keyword or phrase>```
2783

28-
## Feature XYZ
84+
Example: ```find Assignment```
85+
### 10. Exit: ```bye```
86+
---
87+
Format: ```bye```
2988

30-
// Feature details
89+
Example: ```bye```
90+
91+
## :date:Date and Time Syntacts meaning:
92+
| Syntacts | Description |
93+
|-------------------------|------------------------|
94+
| `yyyy` | year in 4-digit |
95+
| 'MM' | Month in 2-digit |
96+
| 'dd' | day in 2-digit |
97+
| `HH` | Hours in 2-digit |
98+
| `mm` | minutes in 2-digit |
99+
100+
## :information_source:Other info
101+
1. Tasks are by default save at data/data.txt.
102+
2. Save action is trigger every time you make modification to the task list.

0 commit comments

Comments
 (0)