You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/UserGuide.md
+46-15Lines changed: 46 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ HobbyList is a **desktop app for managing hobby activities, optimized for use vi
26
26
27
27
***`list`** : Lists all hobby activities in HobbyList.
28
28
29
-
***`add`**`n/Badminton d/play badminton [t/sport]` : Adds a hobby activity named `Badminton` to the list.
29
+
***`add`**`n/42km run d/NUS Run event [t/sport]` : Adds a hobby activity named `42km run` to the list.
30
30
31
31
***`delete`**`3` : Deletes the 3rd hobby activity shown in the current list.
32
32
@@ -43,19 +43,19 @@ HobbyList is a **desktop app for managing hobby activities, optimized for use vi
43
43
**:information_source: Notes about the command format:**<br>
44
44
45
45
* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
46
-
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
46
+
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/42km run`.
47
47
48
48
* Items in square brackets are optional.<br>
49
-
e.g. `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
49
+
e.g. `n/NAME [t/TAG]` can be used as `n/42km run t/sport` or as `n/42km run`.
50
50
51
51
* Items with `…` after them can be used multiple times including zero times.<br>
52
-
e.g. `[t/TAG]…` can be used as `` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
52
+
e.g. `[t/TAG]…` can be used as `` (i.e. 0 times), `t/sport`, `t/sport t/cardio` etc.
53
53
54
54
* Parameters can be in any order.<br>
55
-
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
55
+
e.g. if the command specifies `n/NAME d/DESCRIPTION`, `d/DESCRIPTION n/NAME` is also acceptable.
56
56
57
57
* If a parameter is expected only once in the command, but you specified it multiple times, only the last occurrence of the parameter will be taken.<br>
58
-
e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken.
58
+
e.g. if you specify `d/NUS Run d/NUS Biathlon`, only `d/NUS Biathlon` will be taken.
59
59
60
60
* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
61
61
e.g. if the command specifies `help 123`, it will be interpreted as `help`.
@@ -69,16 +69,28 @@ Adds a hobby activity to HobbyList.
69
69
Format: `add n/NAME d/DESCRIPTION [t/TAG]`
70
70
71
71
Examples:
72
+
*`add n/42km run d/NUS Run event [t/sport]`
72
73
*`add n/Badminton d/play badminton [t/sport]`
73
-
*`add n/Pottery d/make pottery [t/art]`
74
-
75
74
76
75
### Listing all hobby activities : `list`
77
76
78
77
Shows a list of all hobby activities in HobbyList.
79
78
80
79
Format: `list`
81
80
81
+
Example:
82
+
*`list`
83
+
84
+
### Finding a command with keywords: `find`
85
+
86
+
Shows a list of all hobby activities whose names contain any of the specified keywords.
87
+
88
+
Format: `find KEYWORD`
89
+
90
+
* The keywords are case-insensitive.
91
+
92
+
Example:
93
+
*`find run`
82
94
83
95
### Deleting an activity : `delete`
84
96
@@ -90,13 +102,30 @@ Format: `delete INDEX`
90
102
* The index refers to the index number shown in the displayed activity list.
91
103
* The index **must be a positive integer** 1, 2, 3, …
92
104
105
+
Example:
106
+
107
+
*`delete 1`
108
+
109
+
### Deleting all activities: clear
110
+
111
+
Deletes all activities from HobbyList
112
+
113
+
Format: `clear`
114
+
115
+
Example:
116
+
117
+
*`clear`
93
118
94
119
### Exiting the program : `exit`
95
120
96
121
Exits the program.
97
122
98
123
Format: `exit`
99
124
125
+
Example:
126
+
127
+
*`exit`
128
+
100
129
### Saving the data
101
130
102
131
HobbyList data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
@@ -106,7 +135,7 @@ HobbyList data are saved in the hard disk automatically after any command that c
106
135
HobbyList data are saved as a JSON file `[JAR file location]/data/hobbylist.json`. Advanced users are welcome to update data directly by editing that data file.
0 commit comments