Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CS2103T-T15-4] Gim #81

Open
wants to merge 666 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
666 commits
Select commit Hold shift + click to select a range
bafcd84
Add caution message for generate command in UG
ee-suan Oct 27, 2022
eda65dc
Implement mandatory confirm flag for clear
kavantan Oct 27, 2022
9e1d554
Rectify checkstyle errors in ClearCommandParserTest
kavantan Oct 27, 2022
730f7c3
Merge pull request #137 from ee-suan/user-guide
ErvinK123 Oct 27, 2022
7fd8f82
Update :clear section of User Guide
kavantan Oct 27, 2022
b7f43e2
Merge branch 'master' into branch-add-confirm-prefix-for-clear
ErvinK123 Oct 27, 2022
fbce206
Fix indentations in javadocs
ee-suan Oct 27, 2022
df87772
Merge pull request #132 from ee-suan/generate-command
kavantan Oct 27, 2022
b282633
Merge pull request #138 from kavantan/branch-add-confirm-prefix-for-c…
ee-suan Oct 27, 2022
b65d048
Merge branch 'master' of https://github.com/AY2223S1-CS2103T-T15-4/tp
ErvinK123 Oct 27, 2022
2533430
Update images in User Guide
kavantan Oct 27, 2022
516f959
Merge branch 'master' of https://github.com/AY2223S1-CS2103T-T15-4/tp…
kavantan Oct 27, 2022
dca6508
Add page redirects in User Guide
kavantan Oct 27, 2022
e04e287
Merge pull request #139 from kavantan/branch-update-images-user-guide
ErvinK123 Oct 27, 2022
bae0315
Rectify redirects in User Guide
kavantan Oct 27, 2022
f94fa38
Minor changes to User Guide
kavantan Oct 27, 2022
aca0b33
Merge pull request #140 from kavantan/branch-user-guide-minor-updates
24Donovan24 Oct 27, 2022
5e7d338
Merge branch 'master' of https://github.com/AY2223S1-CS2103T-T15-4/tp
ErvinK123 Oct 27, 2022
31b73d7
Update Help para for filter
ErvinK123 Oct 27, 2022
23984bf
Merge pull request #141 from ErvinK123/helpupdate
24Donovan24 Oct 27, 2022
14df34a
Update help paragraph
ErvinK123 Oct 27, 2022
d9784f9
Change help prompt for generate
ErvinK123 Oct 27, 2022
9d999b4
Merge pull request #142 from ErvinK123/helpupdate
ee-suan Oct 27, 2022
9b594c5
Update UG formatting
24Donovan24 Oct 27, 2022
94132ab
Merge pull request #143 from 24Donovan24/final-UG
ee-suan Oct 27, 2022
ad857f5
Update parameter constraint for range in UG
ErvinK123 Oct 27, 2022
f5d0bbe
Merge branch 'master' of https://github.com/AY2223S1-CS2103T-T15-4/tp…
ErvinK123 Oct 27, 2022
3856a91
Add parameter constraint message in RangeCommand
kavantan Oct 27, 2022
82a3fbb
Merge pull request #144 from kavantan/branch-range-command-minor-fix
24Donovan24 Oct 27, 2022
c61d5ef
Merge pull request #145 from ErvinK123/helpupdate
24Donovan24 Oct 27, 2022
bced806
Fix minor bug in Range
24Donovan24 Oct 27, 2022
6188727
Merge pull request #146 from 24Donovan24/branch-MinorFixInRange
stevenlimhw Oct 28, 2022
643dace
Update UG
ErvinK123 Oct 28, 2022
941e681
Merge pull request #147 from ErvinK123/helpupdate
ee-suan Oct 28, 2022
9bce114
Update DG and Javadocs
stevenlimhw Oct 30, 2022
49e3400
Add sequence diagram for range command
stevenlimhw Oct 30, 2022
586c545
Update UserGuide to fix UG bugs
24Donovan24 Oct 30, 2022
a22cb8f
Merge pull request #184 from 24Donovan24/branch-UgUpdate
ee-suan Oct 30, 2022
bc01ada
Add links in Table of Contents to jump to sub-sections
kavantan Oct 30, 2022
b744ef5
Update GUI orientation picture
ErvinK123 Oct 30, 2022
d56e02f
Add front matters and numberings to table of contents
kavantan Oct 30, 2022
18bb529
Remove trailing whitespaces
stevenlimhw Oct 30, 2022
3f94043
Remove trailing whitespaces
stevenlimhw Oct 30, 2022
01b32d7
Rephrasing of 'the user' to 'you' and rephrasing 'extraneous parameters'
kavantan Oct 30, 2022
3f8e8a0
Update User Guide pictures
ErvinK123 Oct 30, 2022
f5dbdb9
Merge pull request #188 from kavantan/branch-user-guide-updates
ErvinK123 Oct 30, 2022
627a47e
Merge branch 'master' into UGupdate2
kavantan Oct 30, 2022
71a6f60
Merge pull request #189 from ErvinK123/UGupdate2
stevenlimhw Oct 30, 2022
a610fbf
Add section in User Guide
kavantan Oct 30, 2022
67be567
Merge pull request #190 from kavantan/branch-user-guide-updates
ee-suan Oct 30, 2022
a03d4e5
Rectify formatting issues in User Guide
kavantan Oct 30, 2022
46dd451
Merge pull request #191 from kavantan/branch-user-guide-updates
ErvinK123 Oct 30, 2022
adaaa58
Rectify formatting issues in User Guide #2
kavantan Oct 30, 2022
0818ba6
Merge pull request #192 from kavantan/branch-user-guide-updates
ErvinK123 Oct 30, 2022
c47c1ca
Rectify formatting issues in User Guide #3
kavantan Oct 30, 2022
9125adc
Merge pull request #193 from kavantan/branch-user-guide-updates
24Donovan24 Oct 30, 2022
0338729
Fix Redirect
ErvinK123 Oct 31, 2022
4b670c9
Fix formatting error
ErvinK123 Oct 31, 2022
8c9bd05
Update UG command descriptions
ErvinK123 Oct 31, 2022
77dfd89
Update UG FAQ
ErvinK123 Oct 31, 2022
3a475e6
Update description of Exercise List
ErvinK123 Oct 31, 2022
d5b1ddc
Update user guide
stevenlimhw Oct 31, 2022
c90e481
Merge pull request #194 from ErvinK123/UGupdate2
24Donovan24 Oct 31, 2022
248aba4
Remove two-digit year patterns
stevenlimhw Oct 31, 2022
1187bbd
Update unit tests
stevenlimhw Oct 31, 2022
1a75bfe
Reduce days input digits for range command
stevenlimhw Oct 31, 2022
86d1d80
Prevent invalid input year 0
stevenlimhw Oct 31, 2022
e713d47
Separate error catching
stevenlimhw Oct 31, 2022
606764d
Add 'Useful Notations' section in User Guide
kavantan Nov 1, 2022
5db1a03
Edit Product Description in User Guide
kavantan Nov 1, 2022
50479c2
Add Gim Logo and standardise :add examples
kavantan Nov 1, 2022
7175ae1
Update pictures
ErvinK123 Nov 1, 2022
3659744
Update PPP with skeleton
ErvinK123 Nov 1, 2022
aa8a719
Update user guide result display explanation v1
ErvinK123 Nov 2, 2022
e783732
Merge pull request #196 from stevenlimhw/branch-issue-148
24Donovan24 Nov 3, 2022
b8518f7
Merge pull request #200 from stevenlimhw/branch-issue-167
24Donovan24 Nov 3, 2022
c443e7e
Merge pull request #197 from stevenlimhw/branch-issue-151
ee-suan Nov 3, 2022
d9ffde3
Merge pull request #198 from stevenlimhw/branch-issue-157
24Donovan24 Nov 3, 2022
8a311c5
Merge branch 'master' into branch-issue-161
24Donovan24 Nov 3, 2022
1f3053b
Merge pull request #199 from stevenlimhw/branch-issue-161
24Donovan24 Nov 3, 2022
55ea604
Merge branch 'master' into branch-user-guide-updates
24Donovan24 Nov 3, 2022
5b8f0b9
Merge pull request #195 from kavantan/branch-user-guide-updates
24Donovan24 Nov 3, 2022
81bd941
Fix parameter constraint for Range command
24Donovan24 Nov 3, 2022
2353ee2
Merge pull request #201 from 24Donovan24/branch-minorUgBug
ee-suan Nov 3, 2022
6dc5562
Merge branch 'upUpdate'
ErvinK123 Nov 3, 2022
91a7824
add tip for recognised exercise name list
ErvinK123 Nov 3, 2022
7be0bfe
Update ppp
ErvinK123 Nov 3, 2022
ecc693f
Update descriptions and diagrams in DG
ee-suan Nov 3, 2022
bd16f20
Update PPP
24Donovan24 Nov 3, 2022
0474fd9
Fix whitespaces for stylecheck
24Donovan24 Nov 3, 2022
af5cfcb
Resolve merge conflicts
ErvinK123 Nov 3, 2022
f4adea3
Fix minor bug
24Donovan24 Nov 3, 2022
4008971
Update PPP for v1.4
kavantan Nov 3, 2022
f0d84b9
Merge pull request #202 from ErvinK123/updatePPP
24Donovan24 Nov 3, 2022
8d4e9ee
Merge pull request #203 from 24Donovan24/branch-PPP
ErvinK123 Nov 3, 2022
40dcc73
Merge pull request #204 from kavantan/branch-update-ppp
24Donovan24 Nov 3, 2022
5991be7
Update PPP for Ee Suan
ee-suan Nov 3, 2022
a2b5382
Update PPP
stevenlimhw Nov 4, 2022
5d4fb60
Merge pull request #205 from ee-suan/skeletal-PPP
stevenlimhw Nov 4, 2022
ee21cbc
Merge pull request #206 from stevenlimhw/branch-PPP
ee-suan Nov 4, 2022
248907f
Merge branch 'master' of https://github.com/AY2223S1-CS2103T-T15-4/tp…
ErvinK123 Nov 4, 2022
90223b3
Update picture for Saved Exercise List window
ErvinK123 Nov 4, 2022
bd95393
Refactor delete description in User Guide
kavantan Nov 4, 2022
4518730
Standardise generate command format in User Guide
kavantan Nov 4, 2022
c1bc95b
Refactor add description in User Guide
kavantan Nov 4, 2022
139db36
Rearrange command summary and implement new notations
kavantan Nov 4, 2022
47a3167
Merge pull request #207 from ErvinK123/upUpdate
kavantan Nov 4, 2022
8bfcace
Standardise tips formatting in User Guide
kavantan Nov 4, 2022
1819009
Merge branch 'master' of https://github.com/AY2223S1-CS2103T-T15-4/tp…
kavantan Nov 4, 2022
a321149
Rectify formatting issues in User Guide
kavantan Nov 4, 2022
4138055
Merge pull request #208 from kavantan/branch-update-user-guide-2
ErvinK123 Nov 4, 2022
09510c2
Rectify 'thinking_face' symbol to 'thinking'
kavantan Nov 4, 2022
fb9b747
Merge pull request #209 from kavantan/branch-update-user-guide-2
ErvinK123 Nov 4, 2022
1d21231
Add examples to :gen for clarity
kavantan Nov 4, 2022
a8c3bbb
Refactor 'Tips and Tricks' section of User Guide
kavantan Nov 4, 2022
3bc5c38
Merge pull request #210 from kavantan/branch-update-user-guide-2
ErvinK123 Nov 4, 2022
86906db
Add test case for Sort command
24Donovan24 Nov 4, 2022
67c0c88
Update DG
24Donovan24 Nov 4, 2022
00dad78
Minor refactor in User Guide
kavantan Nov 4, 2022
48c1232
Merge pull request #212 from kavantan/branch-update-user-guide-2
ErvinK123 Nov 4, 2022
94cd394
Merge pull request #211 from 24Donovan24/branch-DGandTests
ErvinK123 Nov 4, 2022
159acdb
Merge branch 'master' into branch-DG-5
stevenlimhw Nov 4, 2022
0146bc9
Resolve Merge conflict
ErvinK123 Nov 4, 2022
450024d
Update DG description and diagrams for generate command
ee-suan Nov 4, 2022
3160052
Merge branch 'master' into update-DG
ee-suan Nov 4, 2022
098f324
Update UML diagrams
ee-suan Nov 4, 2022
f9314a0
Update use case for generate
ee-suan Nov 4, 2022
72e94a3
Update photo for UiClassDiagram
ee-suan Nov 4, 2022
045f883
Add newline
ee-suan Nov 4, 2022
d021a10
Add class diagram for date and update DG
stevenlimhw Nov 5, 2022
84da827
Merge pull request #213 from ee-suan/update-DG
kavantan Nov 5, 2022
654dc5e
Rectify formatting issue in PPP
kavantan Nov 5, 2022
2a8f946
Rectify 'FindCommand' error in LogicClassDiagram
kavantan Nov 5, 2022
dd97eb0
Rectify 'AddressBookParser' error in DeleteSequenceDiagram
kavantan Nov 5, 2022
22e600d
Rectify 'AddressBookParser' error in ParserClasses
kavantan Nov 5, 2022
1c3c5fa
Rectify errors in 'Model component' in DG
kavantan Nov 5, 2022
0f95055
Rectify 'AddressBook' and 'JsonAdaptedDate' errors in StorageClassDia…
kavantan Nov 5, 2022
f66ba8b
Rectify 'gimbook' error under Common classes in DG
kavantan Nov 5, 2022
4b4e89b
Add design considerations to Exercise Model in DG
kavantan Nov 5, 2022
fc9d288
Remove unnecessary comma in PPP
kavantan Nov 5, 2022
89d1d5f
Add ListPersonalRecordSequenceDiagram
kavantan Nov 5, 2022
40bd9f3
Add section on Exercise Hashmap in DG
kavantan Nov 5, 2022
384fc69
Rectify whitespace issue in DG
kavantan Nov 5, 2022
9e16814
Update Developer Guide
ErvinK123 Nov 5, 2022
f54a228
Merge pull request #214 from kavantan/branch-update-DG
stevenlimhw Nov 5, 2022
5a341ff
Merge pull request #216 from ErvinK123/DGupdate3
24Donovan24 Nov 5, 2022
572f4b0
Update DateTest.java
stevenlimhw Nov 5, 2022
ce729da
Add tests for Date
stevenlimhw Nov 5, 2022
615db91
Update tests for FormatterList
stevenlimhw Nov 5, 2022
33071bf
Fix checkstyle
stevenlimhw Nov 5, 2022
54820cf
Add tests for RangeCommandParser, FormatterList, RegexList
stevenlimhw Nov 5, 2022
7837d99
Update RangeCommandParserTest.java
stevenlimhw Nov 5, 2022
077882c
Merge branch 'master' into branch-DG-5
stevenlimhw Nov 5, 2022
9830318
Merge pull request #187 from stevenlimhw/branch-DG-5
ee-suan Nov 5, 2022
93ff0b9
Update UG
ErvinK123 Nov 5, 2022
835582a
Update DateTest.java
stevenlimhw Nov 5, 2022
9566f81
Merge pull request #219 from ErvinK123/UGupdate3
stevenlimhw Nov 5, 2022
6fa568d
Remove unused tests
stevenlimhw Nov 5, 2022
d6ec3a5
Update tests for AddCommandParser
stevenlimhw Nov 5, 2022
cebe965
Add tests for execute method in RangeCommand
stevenlimhw Nov 5, 2022
3e5e1dc
Add test for Date
stevenlimhw Nov 5, 2022
a09c511
Add tests for DateWithinRangePredicate
stevenlimhw Nov 5, 2022
59ccc3e
Update manual testing section in DG
24Donovan24 Nov 5, 2022
4138b1b
Add more test for Sort command
24Donovan24 Nov 6, 2022
5896996
Update PPP
stevenlimhw Nov 6, 2022
8bd896e
Edit order for test cases
24Donovan24 Nov 6, 2022
cb23d60
Remove methods that are used for non-existing Edit command
24Donovan24 Nov 6, 2022
875a73c
Update diagrams
stevenlimhw Nov 6, 2022
34baf9f
Update PPP
stevenlimhw Nov 6, 2022
c0f8277
Add PrCommandParser test in ExerciseTrackerParserTest
kavantan Nov 6, 2022
0c5fd31
Add SortCommandParser test in ExerciseTrackerParserTest
kavantan Nov 6, 2022
a9ddfda
Add tests for getExercisePR() and getAllExercisePRs() in ExerciseHash…
kavantan Nov 6, 2022
8a521de
Rectify checkstyle errors in ExerciseHashMapTest and ExerciseTrackerP…
kavantan Nov 6, 2022
b634d22
Rectify checkstyle errors in ExerciseTrackerParserTest
kavantan Nov 6, 2022
61f978c
Add test for ExerciseHashMap constructor
ErvinK123 Nov 6, 2022
6266c66
Remove unecessary import
ErvinK123 Nov 6, 2022
16143d9
Merge pull request #217 from stevenlimhw/branch-testing-2
24Donovan24 Nov 6, 2022
56d118f
Merge pull request #222 from stevenlimhw/branch-PPP-updated
24Donovan24 Nov 6, 2022
d1a37f5
Merge pull request #220 from 24Donovan24/branch-FurtherDGUpdate
stevenlimhw Nov 6, 2022
5f0b5c0
Merge pull request #223 from stevenlimhw/branch-DG-6
24Donovan24 Nov 6, 2022
83be92b
Merge pull request #226 from ErvinK123/addTest
stevenlimhw Nov 6, 2022
4060e5f
Add tests for generate command
ee-suan Nov 6, 2022
4b88615
Merge pull request #221 from 24Donovan24/branch-moreTests
ee-suan Nov 6, 2022
f98e917
Merge pull request #225 from kavantan/branch-testing-v1.4
ErvinK123 Nov 6, 2022
ba36462
Merge pull request #227 from ee-suan/generate-tests
kavantan Nov 6, 2022
5664e83
Update RangeCommandTest.java
stevenlimhw Nov 6, 2022
691aab1
Merge pull request #228 from stevenlimhw/branch-testing-3
ErvinK123 Nov 6, 2022
224b57c
Update DG formatting
24Donovan24 Nov 6, 2022
98b10b5
Merge pull request #229 from 24Donovan24/branch-MoreDGUpdates
stevenlimhw Nov 6, 2022
14170d2
Update page formatting for DG
24Donovan24 Nov 6, 2022
f1038ff
Merge pull request #230 from 24Donovan24/branch-MoreDGUpdates
ErvinK123 Nov 6, 2022
888c792
Edit Glossary and label TOC in UG
kavantan Nov 6, 2022
6588ec8
Rectify Pull Request numbering in PPP
kavantan Nov 6, 2022
9f1a38e
Edit 'Back to Top' to 'Back to TOC'
kavantan Nov 6, 2022
833373a
Edit grammar errors in UG
kavantan Nov 6, 2022
9933979
Add hyperlinks to glossary and rectify grammar issues
kavantan Nov 6, 2022
72821a5
Edit hyperlink issue in index.md
kavantan Nov 6, 2022
c6e6562
Merge pull request #231 from kavantan/branch-UG-final-cs2103t
ee-suan Nov 6, 2022
ea6a2a7
Rectify formatting issues in Table of Contents in UG
kavantan Nov 6, 2022
93f3442
Merge pull request #232 from kavantan/branch-UG-final-cs2103t
24Donovan24 Nov 6, 2022
0cd1c02
Update DG
24Donovan24 Nov 6, 2022
a52e358
Merge pull request #233 from 24Donovan24/branch-MoreDGUpdates
ee-suan Nov 6, 2022
f9ef184
add page breaks to UG
ErvinK123 Nov 6, 2022
b5bc482
Update DG
24Donovan24 Nov 6, 2022
8b85bfe
Merge pull request #234 from ErvinK123/master
kavantan Nov 6, 2022
6f7f573
Update AboutUs
24Donovan24 Nov 6, 2022
86b4dde
Merge pull request #235 from 24Donovan24/branch-FinalDGUpdate
ee-suan Nov 6, 2022
492c99c
Update PPP
24Donovan24 Nov 6, 2022
93826a4
Fix checkstyle error
24Donovan24 Nov 6, 2022
d79f188
Page break for UG
ErvinK123 Nov 6, 2022
0e3762c
Fix checkstyle error
24Donovan24 Nov 6, 2022
e3c18aa
Merge pull request #237 from ErvinK123/master
kavantan Nov 6, 2022
baea573
Fix checkstyle error
24Donovan24 Nov 6, 2022
8e38ae2
Added logo in DG
24Donovan24 Nov 6, 2022
73ce072
Merge pull request #238 from 24Donovan24/branch-FinalDGUpdate
ErvinK123 Nov 6, 2022
2977306
Update DG header formatting
24Donovan24 Nov 6, 2022
2f0476f
Update PPP for Ee Suan
ee-suan Nov 6, 2022
850a8cd
Merge pull request #239 from 24Donovan24/branch-FinalDGUpdate
ee-suan Nov 6, 2022
6fcc667
Merge pull request #236 from 24Donovan24/branch-finalPPP
ee-suan Nov 6, 2022
cc35dbb
Merge pull request #240 from ee-suan/skeletal-PPP
24Donovan24 Nov 6, 2022
55b49c3
UpdatePPP
ErvinK123 Nov 7, 2022
fec29ef
update PPP
ErvinK123 Nov 7, 2022
cdaeb0b
update ppp
ErvinK123 Nov 7, 2022
18a8bde
Update PPP
stevenlimhw Nov 7, 2022
6bad64a
Re-organise structure of PPP
kavantan Nov 7, 2022
aac60ff
Merge pull request #241 from stevenlimhw/branch-PPP-2
ee-suan Nov 7, 2022
95eb7d7
Rectify stylecheck errors in PPP
kavantan Nov 7, 2022
fb2c275
Merge pull request #242 from kavantan/branch-update-PPP-final
24Donovan24 Nov 7, 2022
ea65ac0
Fix minor issues in PPP
24Donovan24 Nov 7, 2022
e916e5c
Merge pull request #243 from 24Donovan24/branch-finalPPP
ee-suan Nov 7, 2022
258aac9
Update PPP formatting
24Donovan24 Nov 7, 2022
948795b
Update PPP
ee-suan Nov 7, 2022
8212919
Merge pull request #244 from 24Donovan24/branch-finalPPP
ee-suan Nov 7, 2022
e36646d
Merge pull request #245 from ee-suan/skeletal-PPP
24Donovan24 Nov 7, 2022
f49b9a1
Rectify formatting errors in PPP
kavantan Nov 7, 2022
814f913
Merge pull request #246 from kavantan/branch-update-PPP-final
stevenlimhw Nov 7, 2022
01bf4a4
Fix issues in DG
24Donovan24 Nov 7, 2022
25916e8
Standardise formatting of bullet points in PPP
kavantan Nov 7, 2022
efe5570
Merge pull request #247 from 24Donovan24/finalDG
kavantan Nov 7, 2022
dbf237d
Add bug fix for possibly incorrect error message in generate
ee-suan Nov 7, 2022
09fc71b
Merge pull request #248 from kavantan/branch-update-PPP-final
24Donovan24 Nov 7, 2022
cd79c62
Merge pull request #249 from ee-suan/master
24Donovan24 Nov 7, 2022
4b86ca4
Update PPP
24Donovan24 Nov 7, 2022
e8503c5
Merge pull request #250 from 24Donovan24/PPP
kavantan Nov 7, 2022
5d01a96
update ppp
ErvinK123 Nov 7, 2022
176abd4
Merge pull request #251 from ErvinK123/updateppp2
kavantan Nov 7, 2022
705319f
Update ppp to fit into limit
ErvinK123 Nov 7, 2022
1602592
Merge pull request #252 from ErvinK123/updateppp2
kavantan Nov 7, 2022
a3d9b73
Update ppp
ErvinK123 Nov 7, 2022
07887cc
Merge pull request #253 from ErvinK123/updateppp2
kavantan Nov 7, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add section in User Guide
  • Loading branch information
kavantan committed Oct 30, 2022
commit a610fbf87ccf590d4b354d3f489e101b6ba56482
41 changes: 31 additions & 10 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ title: User Guide

* Table of Contents
{:toc}
--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

## 1. Introduction

### 1.1. What is Gim?
Expand All @@ -19,15 +18,22 @@ Gim is a desktop app for **managing and tracking gym exercises**, optimised for
### 1.2. Who is this guide for?
Are you a gym-goer looking to use Gim to track your exercises? This user guide will get you started in no time and help you navigate through Gim's features. For a quick start guide, head over to [Getting Started](#3-getting-started).

--------------------------------------------------------------------------------------------------------------------

## 2. How to use this guide?
Gim uses a Command Line Interface (CLI), which may be new to some users. If you are a new user, we strongly recommend you to look through the user guide from start to end to fully understand how to use Gim. However, you may also choose to skip to the relevant sections described below:
* Refer to our <a href="#top">Table of Contents</a> to easily navigate between sections of the User Guide.
* Refer to our [Getting Started](#3-getting-started) guide to learn how to setup Gim.
* Refer to our [GUI Orientation](#4-gui-orientation) to better orientate yourself around the GUI.
* Refer to our [Commands](#5-commands) section to learn in detail the different features and commands available in Gim.
* Refer to our [Command Summary](#6-command-summary) to have a quick overview of the different commands and their respective formats.
* Refer to our [Tips and Tricks](#6-tips-and-tricks) for some tips and tricks specific to Gim.
* Refer to our [FAQ](#7-faq) to read common queries that new users may have.
* Refer to our [Glossary of Terminologies](#8-glossary-of-terminologies) to learn key terms that are used in this User Guide.
* Refer to our [Command Summary](#8-command-summary) to have a quick overview of the different commands and their respective formats.
* Refer to our [Glossary of Terminologies](#9-glossary-of-terminologies) to learn key terms that are used in this User Guide.

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## 3. Getting Started

Expand All @@ -46,7 +52,6 @@ Gim uses a Command Line Interface (CLI), which may be new to some users. If you
6. Refer to the [Commands Section](#commands) below for details of each command.

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## 4. GUI Orientation
Expand All @@ -65,8 +70,6 @@ The `Exercise List Window` displays the latest exercise you entered at the botto

The `Result Display Window` displays feedback after executing a command. This includes feedback for both feedback for correctly and incorrectly entered commands.

<div style="page-break-after: always;"></div>

### 4.4. Recognised Exercise Name List

The `Recognised Exercise Name List Window` provides you a list of all unique exercise names that are currently registered in the system.
Expand Down Expand Up @@ -365,11 +368,29 @@ Exits the program.

Format: `:wq`

<div markdown="block" class="alert alert-info">

**:information_source: Gim data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.**<br>

</div>

--------------------------------------------------------------------------------------------------------------------

## 6. Tips and Tricks

Tip 1: Gim's `range` and `find` commands operate on the current exercise list, hence you can use the commands successively to narrow the lists down to what you want to find. For example, you can keep track of your exercise progression over a period of time through the use of `:find NAME` followed by a `range start/ end/`.

Tip 2: Advanced users are welcome to update data directly by editing the data file in `[JAR file location]/data/exercisetracker.json`.

<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
If your changes to the data file makes its format invalid, Gim will discard all data and start with an empty data file at the next run.
</div>

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## 6. FAQ
## 7. FAQ

**Q**: When should I use the `:list` command?
<br>
Expand Down Expand Up @@ -398,7 +419,7 @@ Format: `:wq`

<div style="page-break-after: always;"></div>

## 7. Command Summary
## 8. Command Summary

| Action | Format | Examples |
|---------------------------------|------------------------------------------------|-----------------------------------------|
Expand All @@ -421,7 +442,7 @@ Format: `:wq`

<div style="page-break-after: always;"></div>

## 8. Glossary of Terminologies
## 9. Glossary of Terminologies
* **Vim**: A Unix text editor, known for being lightweight, fast and efficient. It can be controlled entirely with the keyboard with no need for menus or a mouse.
* **Parameters**: Inputs for commands that you come up with.
* **Exercise** : Physical activity done in a regular gym that is structured and repetitive, usually involving some weights.
Expand Down