1- #Introduction
1+ ## Introduction
22
33fitNUS is tailored for ** NUS students** that are interested in staying healthy and keeping fit. It is suitable for ** all
44fitness levels** and is equipped with a ** customisable timetable** for you to manage your time wisely and slot in your
55workout routines with ease.
66
77fitNUS is ** optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, fitNUS can get your scheduling tasks done faster than traditional GUI apps.
88
9- ##Table of Contents
10-
11- <ol >
12- <li > <a href =" [Quick Start](#quick-start) " >Quick Start</a > </li >
13- <li >[Features](#features)</li >
14-
15- </ol >
9+ ![ Ui] ( images/Ui.png )
1610
1711--------------------------------------------------------------------------------------------------------------------
18- <a name =" quick-start " ></a >
1912## Quick start
2013
21141 . Ensure you have Java ` 11 ` or above installed in your Computer.
@@ -25,68 +18,84 @@ fitNUS is **optimized for use via a Command Line Interface** (CLI) while still
25181 . Copy the file to the folder you want to use as the _ home folder_ for your fitNUS.
2619
27201 . Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br >
28- ![ Ui] ( images/Ui.png )
29-
30- 1 . Type the command in the command box and press Enter to execute it. Here are some sample commands you can try:
3121
32- * ** ` routine list ` ** : Lists all routines within fitNUS.
22+ 1 . Type the command in the command box and press Enter to execute it. Here are some sample commands you can try:
23+
24+ * ** ` exercise_add ` ** ` n/Curls t/Upper ` : Creates an Exercise named "Curls" with a "Upper" tag.
3325
34- * ** ` routine create ` ** ` r/Upper Body Session ` : Creates a routine names "Upper Body Session"
26+ * ** ` routine_create ` ** ` r/Upper Body Session ` : Creates a routine names "Upper Body Session"
3527
36- * ** ` exercise add ` ** ` r/Upper Body Session e/Curls ` : Adds an exercise named "Curls" to a routine named "Upper Body Session"
28+ * ** ` routine_add ` ** ` r/Upper Body Session e/Curls ` : Adds an exercise named "Curls" to a routine named "Upper Body Session"
3729
38- * ** ` schedule add ` ** ` r/Upper Body Session d/Monday t/1600-1800 ` : Adds the routine "Upper Body Session" to your
30+ * ** ` timetable_add_routine ` ** ` r/Upper Body Session d/Monday t/1600-1800 ` : Adds the routine "Upper Body Session" to your
3931 timetable on Monday at 1600HRS - 1800HRS.
4032
41331 . Refer to the [ Features] ( #features ) below for details of each command.
4234
4335--------------------------------------------------------------------------------------------------------------------
44- <a name =" features " ></a >
4536## Features
4637
47- ### Help: ` help `
38+ ### Miscellaneous
39+
40+ #### Help: ` help `
4841
49- Lists out all useful commands and their functions.
42+ Links you to the User Guide where there is comprehensive summary of all command in fitNUS. The link will appear in a
43+ pop-up.
5044
5145Format: ` help `
5246
53- ### Create new routine : ` routine create `
47+ ![ Help] ( ./images/help.png )
48+
49+ #### Exit: ` exit `
50+
51+ Save fitNUS data and closes the application.
52+
53+ Format: ` exit `
54+
55+ ### Exercise
56+
57+ ### Routine
58+ #### Create new routine : ` routine create `
5459
5560Creates a new routine by the given routine name.
5661
57- Format: ` routine create r/ROUTINE_NAME`
62+ Format: ` routine_create r/ROUTINE_NAME`
5863
5964Examples:
60- * ` routine create r/Leg Day Session ` Creates new routine with the name "Leg Day Session ".
65+ * ` routine_create r/Leg Workout ` Creates new routine with the name "Leg Workout ".
6166
62- ### Delete routine : ` routine delete `
67+ ![ Routine Create] ( ./images/routine_create.png )
68+ #### Delete routine : ` routine delete `
6369
6470Deletes an existing routine corresponding to the given index.
6571
6672Format: ` routine delete INDEX `
6773
6874Examples:
69- * ` routine delete 10 ` Deletes routine with the index 10 .
75+ * ` routine delete 3 ` Deletes routine with the index 3 .
7076
71- ### Add exercise to routine : ` exercise add `
77+ ![ Routine Delete] ( ./images/routine_delete.png )
78+ #### Add exercise to routine : ` routine_add `
7279
7380Add a new exercise to a specific routine.
7481
75- Format: ` exercise add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
82+ Format: ` routine_add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
7683
7784Examples:
78- * ` exercise add r/Leg Day Session e/Squats ` Adds an exercise named "Squats " to the routine "Leg Day Session ".
85+ * ` routine_add r/Leg Workout e/Squat ` Adds an exercise named "Squat " to the routine "Leg Workout ".
7986
80- ### Delete exercise from routine : ` exercise delete `
87+ ![ Routine Add Exercise] ( ./images/routine_add.png )
88+ #### Delete exercise from routine : ` routine_delete_exercise `
8189
8290Add a new exercise to a specific routine.
8391
84- Format: ` exercise delete r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
92+ Format: ` routine_delete_exercise r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
8593
8694Examples:
87- * ` exercise delete r/Leg Day Session e/Squats ` Delete the exercise "Squats " from the routine "Leg Day Session ".
95+ * ` routine_delete_exercise r/Full Workout e/Squat ` Delete the exercise "Squat " from the routine "Full Workout ".
8896
89- ### View routine details : ` routine view `
97+ ![ Routine Delete Exercise] ( ./images/routine_delete_exercise.png )
98+ #### View routine details : ` routine view `
9099
91100View the details of a certain routine.
92101
@@ -95,66 +104,75 @@ Format: `routine view INDEX`
95104Examples:
96105* ` routine view 2 ` Views routine with the index 2.
97106
98- ### List routines : ` routine list `
107+ #### List routines : ` routine list `
99108
100- Lists out all the routines in fitNUS.
109+ List out all the routines in fitNUS.
101110
102111Format: ` routine list `
103112
104- ### Add routine to schedule : ` schedule add `
113+ ### Timetable
114+
115+ #### View timetable : ` timetable view `
105116
106- Adds a complete routine into the application 's schedule .
117+ View the user 's timetable .
107118
108- Format: ` schedule add r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING `
119+ Format: ` timetable view `
109120
110121Examples:
111- * ` schedule add r/Leg Day Session d/Monday t/1600-1800 ` Adds routine "Leg Day Session" to schedule on Monday, 1600-1800.
122+ * ` timetable view ` Views timetable.
123+
124+ #### Add routine to timetable : ` timetable_add_routine `
125+
126+ Add a complete routine into the application's schedule.
127+
128+ Format: ` timetable_add_routine r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING `
112129
113- ### Delete routine from schedule : ` schedule delete `
130+ Examples:
131+ * ` timetable_add_routine r/Leg Workout d/Monday t/1600-1800 ` Adds routine "Leg Workout" to schedule on Monday, 1600-1800.
132+
133+ ![ Timetable Add Routine] ( ./images/timetable_add_routine.png )
134+ #### Delete routine or lesson from schedule : ` timetable_delete `
114135
115- Deletes a routine from the application's schedule.
136+ Delete a routine or lesson from the application's schedule.
116137
117- Format: ` schedule delete d/DAY_OF_THE_WEEK t/TIMING`
138+ Format: ` timetable_delete d/DAY_OF_THE_WEEK t/TIMING`
118139
119140Examples:
120- * ` schedule delete d/Monday t/1600-1800` Deletes the routine scheduled on Monday, 1600-1800.
141+ * ` timetable_delete d/Monday t/1600-1800` Deletes the routine or lesson scheduled on Monday, 1600-1800.
121142
122- ### Add or edit height : ` height `
143+ ![ Timetable Delete ] ( ./images/timetable_delete.png )
123144
124- Adds height in centimetres.
145+ ###BMI
146+ #### Add or edit height : ` height `
147+
148+ Add height in centimetres.
125149
126150Format: ` height h/HEIGHT `
127151
128152Examples:
129153* ` height h/170 ` Adds or edits the height of the user, which is 170cm.
130154
131- ### Add or edit weight : ` weight `
155+ ![ Add height] ( ./images/height.png )
156+ #### Add or edit weight : ` weight `
132157
133- Adds weight in kilograms.
158+ Add weight in kilograms.
134159
135160Format: ` weight w/WEIGHT `
136161
137162Examples:
138163* ` weight w/70 ` Adds or edits the weight of the user, which is 70kg.
139164
140- ### View BMI : ` bmi `
165+ ![ Add weight] ( ./images/weight.png )
166+
167+ #### View BMI : ` bmi `
141168
142- Calculates and views the user's BMI based on his/her height and weight.
169+ Calculate and view the user's BMI based on his/her height and weight.
143170
144171Format: ` bmi `
145172
146173Examples:
147174* ` bmi ` Views BMI.
148175
149- ### View timetable : ` timetable view `
150-
151- View the user's timetable.
152-
153- Format: ` timetable view `
154-
155- Examples:
156- * ` timetable view ` Views timetable.
157-
158176### Saving the data
159177
160178fitNUS data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
@@ -176,14 +194,14 @@ _{explain the feature here}_
176194
177195Action | Format, Examples
178196--------|------------------
179- ** List commands ** | ` help `
180- ** Create routine** | ` routine create r/ROUTINE_NAME` <br > e.g., ` routine create r/Leg Day Session`
197+ ** Link to User Guide ** | ` help `
198+ ** Create routine** | ` routine_create r/ROUTINE_NAME` <br > e.g., ` routine_create r/Leg Day Session`
181199** Delete routine** | ` routine delete INDEX ` <br > e.g., ` routine delete 10 `
182- ** Add exercise to routine** | ` exercise add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME` <br > e.g., ` exercise add r/Leg Day Session e/Squats`
183- ** Delete exercise from routine** | ` exercise delete r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME` <br > e.g.,` exercise delete r/Leg Day Session e/Squats`
200+ ** Add exercise to routine** | ` routine_add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME` <br > e.g., ` routine_add r/Leg Day Session e/Squats`
201+ ** Delete exercise from routine** | ` routine_delete_exercise r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME` <br > e.g.,` routine_delete_exercise r/Leg Day Session e/Squats`
184202** View routine details** | ` routine view INDEX ` <br > e.g., ` routine view 2 `
185203** List routines** | ` routine list `
186- ** Add routine to schedule** | ` schedule add r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING` <br > e.g., ` schedule add r/Leg Day Session d/Monday t/1600-1800`
187- ** Delete routine from schedule** | ` schedule delete d/DAY_OF_THE_WEEK t/TIMING` <br > e.g., ` schedule delete d/Monday t/1600-1800`
204+ ** Add routine to schedule** | ` timetable_add_routine r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING` <br > e.g., ` timetable_add_routine add r/Leg Day Session d/Monday t/1600-1800`
205+ ** Delete routine from schedule** | ` timetable_delete d/DAY_OF_THE_WEEK t/TIMING` <br > e.g., ` timetable_delete d/Monday t/1600-1800`
188206** View timetable** | ` timetable view `
189207
0 commit comments