|
1 | | -# User Guide |
| 1 | +# **User Guide** |
2 | 2 |
|
3 | | -## Chatbox: Luna |
| 3 | +## **Chatbox: Luna** |
4 | 4 |
|
5 | 5 | ### Luna is an app that uses the CLI to manage tasks. |
6 | 6 |
|
7 | | -## Features |
| 7 | +## **Features** |
8 | 8 |
|
9 | | -## *Adding a todo task: todo* |
10 | 9 |
|
11 | | -### Adds a new todo task. |
12 | | -Format: todo NAME_OF_TASK |
13 | | -Example of usage: todo work |
| 10 | +### **Adding a todo task: todo** |
14 | 11 |
|
15 | | -## *Adding a deadline task: deadline* |
| 12 | +#### Adds a new todo task. |
| 13 | +1) Format: todo NAME_OF_TASK |
| 14 | +1) Example of usage: todo work |
16 | 15 |
|
17 | | -### Adds a new deadline task. |
18 | | -Format: deadline NAME_OF_TASK /by yyyy-mm-dd hh:mm |
19 | | -Example of usage: deadline work /by 2021-02-28 19:00 |
20 | 16 |
|
21 | | -## *Adding an event task: event* |
| 17 | +### **Adding a deadline task: deadline** |
22 | 18 |
|
23 | | -### Adds a new event task. |
24 | | -Format: event NAME_OF_TASK /at yyyy-mm-dd hh:mm |
25 | | -Example of usage: event work /at 2021-02-28 19:00 |
| 19 | +#### Adds a new deadline task. |
| 20 | +1) Format: deadline NAME_OF_TASK /by yyyy-mm-dd hh:mm |
| 21 | +1) Example of usage: deadline work /by 2021-02-28 19:00 |
26 | 22 |
|
27 | | -## *Marking a task as done: done* |
28 | 23 |
|
29 | | -### Updates a task by marking it as done. |
30 | | -Format: done INDEX_OF_TASK_IN_LIST |
31 | | -Example of usage: done 5 |
| 24 | +### **Adding an event task: event** |
32 | 25 |
|
33 | | -## *Listing down all the tasks: list* |
| 26 | +#### Adds a new event task. |
| 27 | +1) Format: event NAME_OF_TASK /at yyyy-mm-dd hh:mm |
| 28 | +1) Example of usage: event work /at 2021-02-28 19:00 |
34 | 29 |
|
35 | | -### Lists down all the previously entered tasks. |
36 | | -Format: list |
37 | | -Example of usage: list |
38 | 30 |
|
39 | | -## *Finding a task using specific keywords: find* |
| 31 | +### **Marking a task as done: done** |
40 | 32 |
|
41 | | -### Lists tasks which contain the keywords. |
42 | | -Format: find KEYWORDS |
43 | | -Example of usage: find work |
| 33 | +#### Updates a task by marking it as done. |
| 34 | +1) Format: done INDEX_OF_TASK_IN_LIST |
| 35 | +1)Example of usage: done 5 |
44 | 36 |
|
45 | | -## *Tagging an existing task: tag* |
46 | 37 |
|
47 | | -### Adds a tag to the intended task. |
48 | | -Format: tag INDEX_OF_TASK_IN_LIST |
49 | | -Example of usage: tag 5 |
| 38 | +### **Listing down all the tasks: list** |
50 | 39 |
|
51 | | -## *Finding a task which has a tag of specific keywords: tagged* |
| 40 | +#### Lists down all the previously entered tasks. |
| 41 | +1) Format: list |
| 42 | +1) Example of usage: list |
52 | 43 |
|
53 | | -### Lists tasks which contain the keywords in the tag. |
54 | | -Format: tagged KEYWORDS |
55 | | -Example of usage: tagged work |
56 | 44 |
|
57 | | -## *Deleting a task: delete* |
| 45 | +### **Finding a task using specific keywords: find** |
58 | 46 |
|
59 | | -### Removes a task from the task list. |
60 | | -Format: delete INDEX_OF_TASK_IN_LIST |
61 | | -Example of usage: delete 5 |
| 47 | +#### Lists tasks which contain the keywords. |
| 48 | +1) Format: find KEYWORDS |
| 49 | +1) Example of usage: find work |
62 | 50 |
|
63 | | -## *Exiting the app: bye* |
64 | 51 |
|
65 | | -### Leaves the app and saves the existing list. |
66 | | -Format: bye |
67 | | -Example of usage: bye |
| 52 | +### **Tagging an existing task: tag** |
| 53 | + |
| 54 | +#### Adds a tag to the intended task. |
| 55 | +1) Format: tag INDEX_OF_TASK_IN_LIST |
| 56 | +1) Example of usage: tag 5 |
| 57 | + |
| 58 | + |
| 59 | +### **Finding a task which has a tag of specific keywords: tagged** |
| 60 | + |
| 61 | +#### Lists tasks which contain the keywords in the tag. |
| 62 | +1) Format: tagged KEYWORDS |
| 63 | +1) Example of usage: tagged work |
| 64 | + |
| 65 | + |
| 66 | +### **Deleting a task: delete** |
| 67 | + |
| 68 | +#### Removes a task from the task list. |
| 69 | +1) Format: delete INDEX_OF_TASK_IN_LIST |
| 70 | +1) Example of usage: delete 5 |
| 71 | + |
| 72 | + |
| 73 | +### **Exiting the app: bye** |
| 74 | + |
| 75 | +#### Leaves the app and saves the existing list. |
| 76 | +1) Format: bye |
| 77 | +1) Example of usage: bye |
0 commit comments