Skip to content

Commit f93d18c

Browse files
authored
updated User Guide (AY1920S1-CS2113-T14-2#37)
* B-Reminders * B-reminders modification * duke.java * modified buidl.gradle and Command * user guide * user guide table of contents * user guide link TOC * user guide * UI * corrected mock UI * rename UI * UI update * updated user guide
1 parent e89979f commit f93d18c

File tree

2 files changed

+71
-23
lines changed

2 files changed

+71
-23
lines changed

docs/README.md

Lines changed: 70 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,23 @@
11
# Restaurant Manager - User Guide
22

33
1. Introduction
4-
2. Quick Start
4+
2. Quick Start
55
3. Features
66
- bye: Exit the program. [Level-1]
77
- list: Show all the tasks. [Level-2]
88
- done: Mark a task as done. [Level-3]
99
- todo: Create a new todo task. [Level-4]
1010
- deadline: Create a new deadline task. [Level-4]
1111
- event: Create a new event task. [Level-4]
12-
- Handle errors and invalid inputs. [Level-5]
1312
- Load and save tasks to hard disk. [Level-7]
1413
- Identify dates and times. [Level-8]
1514
- delete: Delete a task. [Level-6]
16-
- Perform text UI testing. [A-TestUiTesting]
1715
- find: Find a task by searching for a keyword. [Level-9]
18-
- Object-oriented. [A-MoreOOP]
19-
- Perform JUnit testing. [A-JUnit]
20-
- Have comments. [A-JavaDoc]
2116
4. Command Summary
2217

2318
## 1. Introduction
2419

25-
Duke is targeted towards restaurant chefs who wants to be able to consolidate most of the things happening in their kitchen such as recipes, ingredients, expiry dates etc.
20+
Duke is targeted towards restaurant chefs who wants to be able to consolidate most of the things happening in their kitchen such as recipes, ingredients, expiry dates etc. By using this product, you are able to order all the ingredients needed for your kitchen. Additionally, you can try out new recipes and save it in Duke. you can also view customer feedback.
2621

2722
## 2. Quick Start
2823

@@ -36,59 +31,112 @@ Duke is targeted towards restaurant chefs who wants to be able to consolidate mo
3631

3732
![UI](https://github.com/9hafidz6/main/blob/master/docs/images/UI.png)
3833

39-
5. Type into the INPUT box some commands and press ENTER to execute
34+
5. Type into the INPUT box some commands and press ENTER to execute
4035

4136
6. Some example commands
4237

43-
1. **list**: lists out all the tasks
44-
2. **deadline** prepare new recipe **/by** 1/1/2019: adds a deadline task "prepare new recipe" into your list by "1/1/2019"
38+
1. **list**: lists out all the tasks
39+
2. **deadline** prepare new recipe **/by** 1/1/2019: adds a deadline task "prepare new recipe" into your list by "1/1/2019"
4540
3. **bye**: exits the program
4641

47-
7. Refer to Section 4 for the full list of features
42+
7. Refer to Section 4 for the full list of features
4843

49-
## 3. Features
44+
## 3. Features
45+
46+
**command format**
47+
48+
- commands are in `UPPER_CASE` are to be provided by the user eg. `todo d/DESC`, `DESC` is a parameter which can be used as `todo d/buy groceries`
49+
-
5050

5151
### 3.1 bye: Exit the program. [Level-1]
5252

53-
Saves data onto local storage and exits the program
53+
outputs an exit message to the user and terminates the program
5454

55-
Format: `bye`
55+
Format: `bye` 
5656

5757
### 3.2 list: Show all the tasks. [Level-2]
5858

59-
Shows all the task marked done/undone to the user
59+
Shows all the task marked done/undone to the user
6060

6161
Format: `list`
6262

63+
shows the user all the tasks that is stored in Duke
64+
65+
Here are the tasks in your list:
66+
1.[D][✓] return book(by: Monday)
67+
2.[E][✘] meeting(at: U-Town)
68+
3.[P][✓] lecture(from: 1600 to: 1800)
6369
### 3.3 done: Mark a task as done. [Level-3]
6470

6571
marks a task in list as done.
6672

67-
Format
73+
Format: `done` <indx>
74+
75+
eg. `done 1`, outputs: [ T ] [] return book
6876

77+
Nice! I've marked this task as done:
78+
[D][✓] return book(by: Monday)
6979
### 3.4 todo: Create a new todo task. [Level-4]
7080

81+
creates a new task, todo where user enters the description of the task that needs to be done
82+
83+
Format: `todo` <desc>
84+
85+
eg. `todo order eggs`, stores T|0|order eggs, outputs [ T ] [] order eggs
86+
87+
Got it. I've added this task:
88+
[T][✘] order eggs
89+
Now you have 6 tasks in the list.
7190
### 3.5 deadline: Create a new deadline task. [Level-4]
7291

92+
creates a new task, deadline, where user enters their tasks as well the date that the task needs to be done
93+
94+
Format: `deadline` <desc> `/by` <desc>
95+
96+
eg. `deadline submit review /by 1/1/2019`, stores D|0|submit review|1/1/2019 , outputs [ D ] [] submit review (/by: 1/1/2019)
97+
98+
Got it. I've added this task:
99+
[D][✘ ] submit review(by: 1/1/2019)
100+
Now you have 5 tasks in the list.
73101
### 3.6 event: Create a new event task. [Level-4]
74102

75-
### 3.7 Handle errors and invalid inputs. [Level-5]
103+
creates a new task, event, where user enters their tasks as well the date that the task needs to be done
104+
105+
Format: `event`<desc> `/at` <desc>
106+
107+
eg. `event birthday /at multi purpose hall`, stores E|0|submit review|multi purpose hall , outputs [ED ] [] birthday (/at: multi purpose hall)
76108

109+
Got it. I've added this task:
110+
[E][✘] birthday(at: multi purpose hall)
111+
Now you have 4 tasks in the list.
77112
### 3.8 Load and save tasks to hard disk. [Level-7]
78113

79114
### 3.9 Identify dates and times. [Level-8]
80115

81116
### 3.10 delete: Delete a task. [Level-6]
82117

83-
### 3.11 Perform text UI testing. [A-TestUiTesting]
118+
deletes a tasks that was stored in Duke regardless of it being marked as done or undone.
84119

120+
Format: `delete` <indx>
121+
122+
eg. `delete 1`, deletes the first task that is stored in Duke, if task does not exist, output an error message to user `Enter a valid task number after done, between 1 and x` (x is the total number of tasks in Duke)
123+
124+
Noted. I've removed this task:
125+
[T][✓] read book
126+
Now you have 3 tasks in the list.
85127
### 3.12 find: Find a task by searching for a keyword. [Level-9]
86128

87-
### 3.13 Object-oriented. [A-MoreOOP]
129+
finds a task in Duke which contains a specific word or description
130+
131+
Format: `find` <desc>
88132

89-
### 3.14 Perform JUnit testing. [A-JUnit]
133+
eg. `find eggs`, iterates through all the task in Duke and if any of the tasks contains the description, output the task to the user
90134

91-
### 3.15 Have comments. [A-JavaDoc]
135+
Here are the matching tasks in your list:
136+
1.[T][✘] stock up on eggs
137+
2.[D][✘] buy eggs(by: Monday)
138+
3.[T][✘] create a new egg sandwich
139+
if there are no matches, outputs `No matching tasks found!`
92140

93141
## 4. Command Summary
94142

@@ -102,4 +150,4 @@ Index | Keyword | Usage
102150
6 | event | event \<desc\> /at \<date\>
103151
7 | delete | delete \<indx\>
104152
8 | find | find \<desc\>
105-
9 | remind | remind
153+
9 | remind | remind

src/main/java/duke/command/RemindCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public void execute(TaskList taskList, Ui ui, Storage storage) throws DukeExcept
4040
}
4141
}
4242
} catch ( Exception e) {
43-
//
43+
System.out.println(e.getMessage());
4444
}
4545

4646
}

0 commit comments

Comments
 (0)