From f27cfc57e997d614151c5daed19481b4f2eae4fb Mon Sep 17 00:00:00 2001 From: JJtan <95962077+JJtan2002@users.noreply.github.com> Date: Sun, 10 Nov 2024 19:03:18 +0800 Subject: [PATCH] Update UserGuide up to Command Summary --- docs/UserGuide.md | 107 +++++++++++++++++++++-------------- docs/images/DownloadPage.png | Bin 0 -> 16685 bytes docs/index.md | 2 +- 3 files changed, 64 insertions(+), 45 deletions(-) create mode 100644 docs/images/DownloadPage.png diff --git a/docs/UserGuide.md b/docs/UserGuide.md index ba758fbf6c0..57ad37c781d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -5,8 +5,12 @@ --- # GamerBook Pro Max User Guide -GamerBook Pro Max is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). +GamerBook Pro Max is a **desktop app designed to make managing your gaming contacts a breeze**. This app is useful for gamers who have many friends online across different games. + +GamerBook Pro Max lets you type quick commands using a Command Line Interface (CLI) while still enjoying the ease and visuals of a Graphical User Interface (GUI). + +You get the best of both worlds: speedy command-based interactions with an intuitive, user-friendly display! If you can type fast, GamerBook can get your contact management tasks done faster than traditional GUI apps. @@ -21,18 +25,20 @@ If you can type fast, GamerBook can get your contact management tasks done faste ## Installation and Quick Start -1. Ensure you have [Java `17`](https://www.oracle.com/sg/java/technologies/downloads/) or above installed in your Computer. You can check your Java version by opening a command terminal (e.g. Command Prompt) and typing `java -version`. +1. **Check your Java version**: Ensure you have [Java `17`](https://www.oracle.com/sg/java/technologies/downloads/) or above installed in your Computer. To check, open a command terminal (like Command Prompt) and type: `java -version`. -2. Download the latest `.jar` file from [here](https://github.com/AY2425S1-CS2103T-T12-4/tp/releases). +2. **Download GamerBook Pro Max**: Download the latest `gamerbook.jar` file from [here](https://github.com/AY2425S1-CS2103T-T12-4/tp/releases). +![DownloadPage](images/DownloadPage.png) -3. Copy the file to the folder you want to use as the _home folder_ for your GamerBook. +3. **Set Up Your GamerBook Folder**: Copy the file to the folder you want to use as the _home folder_ for your GamerBook. -4. Open a command terminal, use `cd` to navigate into the folder you put the jar file in, and use the `java -jar gamerbook.jar` command to run the application.
+4. **Run the App**: Open a command terminal, use `cd` to navigate into the folder you put the jar file in, and use the `java -jar gamerbook.jar` command to run the application.
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
![Ui](images/Ui.png) -5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +5. **Try Out Some Commands!**:Type the command in the command box and press Enter to see it in action! +Here are a few examples: + * `help` : Opens the help window. * `list` : Lists all contacts, this is useful after you filter the GamerBook using commands such as `find`. @@ -42,6 +48,8 @@ If you can type fast, GamerBook can get your contact management tasks done faste * `clear` : Deletes all contacts. + * `undo` : If you just used `clear`, this will bring back all your contacts! + * `exit` : Exits the app. Refer to the [Features](#features) below for more details. @@ -51,33 +59,31 @@ Refer to the [Features](#features) below for more details. ## Exploring the GUI -Our Graphical User Interface (GUI) consists of several parts, refer to the image below. +Our interface has a few key parts (check the image below for a visual guide): -1. **Menu Option**: By clicking the buttons here around the top right, you can exit the app or open the help window. +1. **Menu Options**: Click the buttons in the top right to exit the app or open the help window. -2. **Command Input Box**: You may input commands here. +2. **Command Input Box**: Type your commands here! -3. **Result Display Panel**: Results of command execution and error messages are displayed here. +3. **Result Display Panel**: See the results of your commands or any error messages here. -4. **Person Cards Panel**: Person cards are listed here. +4. **Person Cards Panel**: A list of all your contacts will appear here, each on their own card. ![UiTut](images/UiTut.png) -### Command PopUp +### Command Suggestion: Your Shortcut to Faster Commands ![CommandPopUp](images/commandpopup.png) -Our Command Suggestion PopUp helps you find the command you need with ease. - -When you start typing in the command box and have **at least one** character entered, the PopUp will appear, suggesting possible commands to complete your input. +Our Command Suggestion PopUp helps you quickly find the right command as you type! Each suggestion includes the command name, command format and any required details to use it effectively. -To cycle through the suggestions: +To scroll through the suggestions: * Press `shift + up` or `shift + down` and the **current selection** will be highlighted in **blue**. - _In the image the **current selection** would be `editgame`._ + _In the image above, the **current selection** would be `editgame`._ @@ -91,66 +97,79 @@ Quickly complete your commands! Need a quick reference? -* The suggestion will stay open as you finish your command so u can reference it in case you forget any syntax. +* The PopUp stays open as you finish typing your command, so you can check it for syntax or details if you need them. + -**Note:** Autocompleting will overwrite **ALL** text in the **Command Input Box**. Be careful when using it. +**Note:** Autocompleting will overwrite **ALL** text in the **Command Input Box**. Be careful when using it! -**Note:** The Command PopUp will try to remain fully visible on screen at all times for your reading convenience even when -the main window is partially off-screen. +**Note:** The PopUp will adjust its position to stay fully visible, even if your app window is partially off-screen. -------------------------------------------------------------------------------------------------------------------- -## Features +## Important Notes about Command Formats -**Notes about the command format:**
-* Commands are **case-sensitive** and also fully **lowercase** - e.g. `clear` is recognised as a command but not `Clear` or `cLEar` +* **Commands Are Case-Sensitive and All Lowercase** + Make sure to type commands exactly as shown. e.g. `clear` is recognised as a command but not `Clear` or `cLEar` + + +* **Copying Commands from PDF** +If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. + +### Understanding Parameters +* **Words in `UPPER_CASE`** are placeholders for you to replace with your own input. + e.g. `add n/NAME` means you would type something like `add n/John Doe`. + -* Words in `UPPER_CASE` are the parameters to be supplied by the user. - e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +* **Items in square brackets are optional**. + e.g. `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or simply `n/John Doe`. -* Items in square brackets are **optional**. - e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. -* Items with `…`​ after them can be used multiple times. +* **Items with `…`​ after them can be used multiple times.** e.g. `[t/TAG]…​` can be used as `t/friend`, `t/friend t/family` etc. -* Parameters can be in any order. + +* **Flexible Parameter Order** e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored. + +* **Ignored Extra Parameters** for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) e.g. if the command specifies `help 123`, it will be interpreted as `help`. -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. -**Notes about command parameters:**
+### Notes About Command Parameters:
-* `NAME` **only** accepts alphanumeric characters and spaces. We acknowledge that names can contain special characters like `-` or `/`. - e.g. `Flora-Ann`. We ask that users workaround this issue by using spaces or other alternatives to name contacts. +* `NAME` **only accepts alphanumeric characters and spaces**. + Names with special characters like `Flora-Ann` should be adapted by using spaces instead. -* `INDEX` must be a **must** be a **positive integer** (`1`, `2`, `3`, …) or it will be read as invalid command format rather than an index value error. -* `NAME` is **case-sensitive**. Although duplicate contact names are not allowed, -e.g. adding two separate contacts `Bobby Ang` and `bobby ang` would be allowed. +* `INDEX` **must be a must be a positive integer** + If it’s not, you’ll see an invalid command format error. -* `TIME-TIME` should be in the format `HHmm-HHmm` and must be a valid time range within the same day. + +* `NAME` **is case-sensitive**. +Although duplicate contact names are not allowed, adding two separate contacts `Bobby Ang` and `bobby ang` would be allowed. + + +* `TIME-TIME` **must be within the same day** + Use the format `HHmm-HHmm` for time ranges within the same day. e.g. `1700-2200` is a valid time range whereas `2300-0100` is not a valid time range. -* `TIME-TIME` time ranges cannot be a single point in time. - e.g. `1200-1200` is not a valid time range. + +* **No single points in time for `TIME-TIME`** + The start and end times must be different (e.g. `1200-1200` is invalid). @@ -172,7 +191,7 @@ e.g. adding two separate contacts `Bobby Ang` and `bobby ang` would be allowed. | **FavGame** | `favgame INDEX g/GAME`
e.g.,`favgame 2 g/Overwatch` | | **UnFavGame** | `unfavgame INDEX g/GAME`
e.g.,`unfavgame 2 g/Overwatch` | | **Find** | `find KEYWORD [MORE_KEYWORDS]…`
e.g., `find James Jake` | -| **FindGame** | `findgame KEYWORD [MORE_KEYWORDS]…`
e.g., `find James Jake` | +| **FindGame** | `findgame KEYWORD [MORE_KEYWORDS]…`
e.g., `find Overwatch League` | | **FindTime** | `findtime TIME-TIME [TIME-TIME]…`
e.g., `findtime 1800-1900 2000-2200 ` | | **Delete** | `delete INDEX`
e.g., `delete 3` | | **Clear** | `clear` | diff --git a/docs/images/DownloadPage.png b/docs/images/DownloadPage.png new file mode 100644 index 0000000000000000000000000000000000000000..0a706e0d0bc4d6354ab74a28d15c7f7e86e043d1 GIT binary patch literal 16685 zcmc(mbyOV9y6zzY0YXS{LV(~F+}(n^ySoSXfdqGg26uONNN{(z3GRct-JX0~?%C(; zbL$tWO1?23NSFwzXG3kUp)iJBh4Z#toWu)VegMldk^9paw_ zlw5TVmywl}W;5xIkwbigUcILO`L^3EYfZB9RRJN(f(J321vW!uK_l6ODXB$^m|~Fv zb+<-%0;`~#1$~Rf5C(BEYEay(#?l@*r|aVZr=zmJ&|I6iYNp*D$hCY2w zZ7rYc@o#U zguS$z=zJ>#y&C~!zO3F}r_2wd_qkjNG3BLH$o%c`AYXBdE>#wHV3Mgha10(D}@WT>tLj}qo+?-vZr&dPpPusmh;;$;UD|XFYdXgj71^G&F@d6JHhw; zVK|=Iv$D@zw6T|D=4a|yRo++hvO}LOJ(68ZZO`%Hwb6)ly*M4v!!Jx+TwImiyxX~f z^n)Q{9fl_$vZ@-^(^mO7J2)&U(%ISLcE6ww9(v1V4Ox zlOFt3IGnn!|0^AxRY|3O;=poyi~Vbqd1m30?M06F=eDXxTjm0ZykXrvfwsHLcFB~^ zCpXS>jz`|Kl<$=nA%@f#-c9{fuy!0Cjg$z>Vf8g#5^g}-uxoGKSSJH3y>HnWf|bt? z?uYBr1KS3vcw+HxX1#ABQ5j8V>&aK_$UdijxF0wwj|x7zHyxoZlZ}0QSU8R3tVLqe ze!V~2p4eGm6R+E7zIze)z@ek~YWX5Nt{<7T{BZF4 zO!K^ox!*+i*6LofczACk1>D9R&l>Ap6}FFv%sIqJE!|1}bV#mAht{i`(ziUIvn#V= zEqSCK;knt*!UneWKK4;=LVp0Kmo~Pp78kf_2{X!b%6G8sS7LL`3|Md%15JYoV|)nf z7QMf_8)3vL4$`^RtqzBi6O?EZqs@FutTkdtM-M*hm^B@LV#dGQf7vF}_X2^Se}L|B zb{dYbU3{qlW&p!4ZMwrjeX~^S>su~fA5?qD*#?|op6zw*TYk!9(!uzNCuXe%Gsmjk z&ytV!3xi;-!gbuBjmBR{8B;=?NUN4g7+U9!Uw+rEz{WD#69L!svtUdXE>4U@vjc33 zF&^)IG@rG-S82F;&Nm5mmHu$#ta%HECD^~)UIp*3@o>QA`LyjqP<}gZ1^%f^sykKn zQ(On}A+p{KyOg*2uokCUSMwpTTym~jcu+E=;VJgOL;A<-0bBju`!X&Oa#x9Oyw|l@ z;XbpxZ!QyA4Ba*=2dCGlk>7Np7`p##73;y&l}%4?tG&{4Isz#el0zrkus6?dQ*xq| zE$!{k{7y%o={~ie5Fi*or+otTwA;xVGn$<|7K_GL>in9iLh40bdvv|!Wb;)_nV~$e zXaG^^gL~6G2aVMkO=fHv6}%b3!>hSQbWar9G?mh4+YdpZl8vpsYi^~R+Y#MQCu88Y z^;x=k3e@(8bwS@VHG;HWrk4Xc z2!Ij!5HhyDxr{|~qG9WG>aFsyYEPWl&UMA7x*RDa{E5cY%u$l~p ze@x%tGFszG-#$1s370K6(NRq2Nh-x@zwN&~v3uF>oyZb2G(1eMA*+W0T$Yc#3IC`` z65lA>#xO=rg}IO#0j!eeCyK;2QkJXx+1o{M_BE-1TYkF&T2`yOif0}wj%D>+BzStt zJpt4TTD3}?3#Ce|yT%|d8=D#v>{}x(AJ4js0pH8J(9R~h@3r!UOiBr>mhEf>s_6Ek z=BJ<&m1m@TtE<8R8Zo1R$AYFBO2eWW`ocq zaKIqdgmH44^n`hv-RI!PeFfU%OVHiI99e7}zD#5)Jhy+Ofqa#S$RxM-W(vF~p744A zlZ;Gm-Ew!5DthaGq@ab|jAJp*(>;#T(1e$dWEO6F9~z%0yD|r)4=dR*WOqD} zGm%+5Ro|AA#UQ>&F5iU(*efXRk z+GH3J3??R~K|9PkG;;QZ#R{_Z+tG~D!$UqLB}o#@3Go?~cvN?%y64cU{GSz#9V9J> zmpw{L4`a0PNH8(20tp{X$JVMOG?Nh`oFBH;q4i*_wS~NdCXp1i)Rv<_TfP>SxFo1Z zFXW)Rus^=XGxy11h@M8?CHI|SV-+V?uZDIH%ukpx7;!_AV(bZ7IBRpu`l{H9|Fr$^ z;Gm0$1X|mbgqi=cb?4P6JhYo&6ougaDw%}gXg*QhT#KDT=3Z#%Nkezihg>izJ@K&( zg3i~_RoomG_7=K`d;NEIcl2b7ksh{6)#_s7{r@yk@ADp)$Qyk)o{P@Ua9CPqQyg%I?QShI+T1l4B7ZWp%1fRpEVm5{~jnnH=ur8Vvay@O*1#PO& zyIo47vFZJe-C5p%W&g%Ze5Smkpd~3Wr=6ar7%LRQ^My)3B=I zn))+1!A8`b_1$A4?)>%IHY(&Zb7^XZ)h_Y#PR5S#cZqpd%qa3klSOtX2np=MMRaQJp3$LXag ztaRdj*U&|@&_0Oot86{ug-aq(r5O{5~9=s7<*vPfsGE*kiqxM<|U#zG9> zaW=NzZySmXXpDf#X%gO}9VPphI-MPDEAAHyv0-ZBO|0}$B)`|Ox&WPgBPk7V%BiE6 zyy*$=R$QM_?OvH466(fJteL3vV&kbyss*n5HEm-x*LXn}h)&tUAVe~w3@e5hC2V?s zmYMbm21_{{FEKq{!0{JW07H0DbVD-^wvlQsM5C29Wie}H=OV^pBI{bjMsnln$EwDg zjbknjt+*r0QNEvV(295*4-cImQa)=N(zbr}yH7iGoMd@ZMCi@CQw%yYLv?bj$k()2 z;4ZDg^NOBNdUqcm~xEyTtk zfJ$}~uRBkZ9V73{YV`iuh)PJKTwH?o<~!6+gVGsCuqR?{b=8tG`1+HqD<{PR5@Szk#Flo1!)!x0pKw6Z9@R=;#2Q)t4tB z0xhCte}|)+c1OFplyyVoSF3{k(V667*9?_Y>(JzU4__AxMA*3`w>Hj-TeTw9h_o7i zupVgU>u2f1OMHuh1PUJ#_j{9A%;Bq+W^q4=6GWBGWs0VtyeG(7VEX)^OmC)ExBq}Y zwy`yRP1$wg4z745o7v?QV{1Si)0C&#=llEtapYBugz|uATt1s-c@LRkpQoqCMfGh! zFjD3YSS+U|WiYmJK+w(S+j1E97fG08qK^9g$DHq!==en~EduEs7Fn-vgE&K|ID;Cy zrA*f#5|jFO(?|Z7Cz=gTk}4w23WuM%2yWCg5eQMZ%!69xh5H<$6HB~4%)SAp;Toe5 zo=@+4Mu>AilO@C~y|AJ2Y)8rpkMciQbtpZF-L1aCYyZaG8k|qxvO(roF5|$&c$B53 zOqy$p>f3;J({4)S^bqT*%f(k18=%Sx-)YKJ4->&vwJ6snGy9{h;dXeg#7F1Qp3P0! z?Pc-nB*OlTrL61F0etGUi*fDQ(2!mIk`?X2tGLDTcUP)px5;RU37bS`BVN7KHeb%z z$zARD<4GVLcCEF%R__q;taFk5)Dk1f*Ov}o$=Amr9_AD}(qm2m%f#!bIqA4`p{G?k zz0_>2AHN4W&f8$K8sqb%*0ZyyYOf>lUUPL+$47_rat}&Fl(LhVKjrYla>-wNh#chS zcy66|#T2zzG0uv%P=seL>95>;=P{(X!lsM+_MkmA-7ldQSdbw|YNVC8l&i_r+dmu^ z2R9sLG*&TIzdO5Ji9kRAtje>9;m;HbZPXHIK|A?EiN+MJdb`qa%w6^qYC;muU54xfm@uwTqaRYsXU7(T_kHoDo{Q* z7$iL=x%GLmW>3*tKwbMbe*tVhUkNNSLJ`R@RE~Y{}YB{+2F*XJ@i^`=v@(HbS%RN~`W@6F<@DD8hWzH|-D>Mh|_RfS9i9CFK*nTU$XO7eB__1I|TBei7Jo z>dXNVX%iM$F<*=pc(Zk|zvkR$WGtsO9WxeMA&jb8PXJXpOHVJ~+jHj&UM+)im8vbIT zxBSprA~9v=_`W3McHUp7Y*#W~j)9P^`3ev+37}L=*?4I%b z#)Il59zAJP=mB5TJzV)NNMYMDfg`8gkQ1ua5qtt&pdr)w*qEbtR60t?caty=R_i?HuLl(adWYHMpHosJqmVr0IRP>v8DNW&Z56nZe0NNB)tUg zyv?6|aRKzcX}70V*L6QSvZ66;Thda{37+(sX|(95^1>alqM>U3X8{XI`n0%%>Du>o zW@Fm(~q>o9eKL`c(P^HXYg z(K*)khV7oiBq^%zD=H*`1})Z0uMt(eh%hj8a6?-saMf$;BLc4HqJ1WjO91to&2J-k z{q=)No>F16N;%SYy|y{kOhF`mySuglZSiiuc#dgs!bFZR0@iAM0aHNPi_X_ixah18 z^?nTJsc#dD^yA)H6!ff_&$L99=1^Ama^~1p#dW~&@aQ?x$Xi%9XF~3e2I??X-~qKN z?L=m;ef{`MWqmWh@L5dETBCLAC(;GE8IsSC9PwQoUS@N1{}PH*%~4%)N-962?(p-9 z(}T$z%4Gw8U9X|&iOzthXE@dYRKB#HZYvRe!yTL?nVPX=G8$ss(FeeK*t`RKFeY!% z(wWKED%ZI3D|#9jRU28b%$#64GODg%mg6m(1?~h4FAPE%e-4q`P9-F%#K?N3Tq;u*>^!58;ji|Y6ezDxO8QmSMguanVm25I-R}d(^)rjjQIWxzLeGJz zwMODO#d7zXwdGdzN(;@(=^le(Yh%%NifsQe?y}a+cuq$bgxR*rInZqC*;RvxK8zQb zwD!xu6knlj4cmwC?C@@tclGtUXm>bA)7`zxRo?A$dk+SY>=)s0%B0y{JbLiTj}3~2 zrtj@?a?4EaXfO9p*qUWzxg8h%@kJK-8d_ITpB7Ty4Cive%6oFTY$E2`MDEzEpwQxm zV&z<6JD0!7&9A_+9=I==BL3Dcc3rBhizIpq|Dk~Wmi(3myru~Q^Lw5IB}{suP%pDH z!(KT~$>td5=;zz$xI8Rbhd6%_q9N9x?BGYjUj{Y)ramId;!Dd$C3*RlMI!Y#7`KXa zer*nA!nXYB#i!4&Zs6zi;d)P+FP)p)Y@+$661Ci)Bi!&T?&ev3P!jqf@Ur}NI9q&b z{8ySyzxYYbfb-5&f$Bpe<+7Ijm(a5~w%$C?#hwKOd8}HEHX@oO;&xO#$sr z_b&_|SK6F?4?^7xnd{$U*-n~_RJB*>cMzS@KYkuYw(%Ca7oA=_3VWbX(7`rgDa^4u zF>Nxw#yfE{jDETnJcEO8Tfj+}FvIysy<~tlwNm#Wr@ZCm?EX3U#)BFUv3|kY337eT zbP+(k6uvx6oqnb+S=j8Sj)m-c>}QM8v`QUEnzD1L2WmA>%PpE-W*nEiG=jYHa?FiCw{|(u%y*ioYTupRDix z{lBP2TeyFy#xpiRHKIQCWeS|p2fx*EL=*2XSk?4*mKF>9;;AIIS(*7Gh4UYx(NWdC z^2RgpW=2;^=WeYlapiRCBT}93+bbW+K+O5ZMU7!CqxRwNCKId-hl&0#`ycY>t^=ix z^Ba#j_K6>znRM-u(}l$zIvJauEFPR|)#nzrXJjhvy~Xjj4V~Gpbn?DX@woW!50zmN zQiD@I99pkGW(~f(ohU6epY@*$6-<37nHT(QVkwf zpHZv80SSd5NnD(&AfC0~R<>;`Amy7z&sW3J!$h!%1a0c+>;%lbpKDEnnhN!fE3L3* z_OXikhl@`XgKQE0(y1i|53=+e-W@#2^i|FSLG|Vog>5a+`e^>p0KA? z+@eC-Y;s8ebgYjO#pz*FyS34IWLDal5S(u?qZvU66#=RNgEv*NhKAF!LZ}9=L&lV) zX0T*~dviR?>CjT{z5aUd+(daaLkGzq4x_WpZmP2&CmPDh^K)SQQgb2jVU996)Eknf zxl*3wYI2Gd?!i9v52bU;n2~R-FIm4T^e7;sVJmv&Cc_wW_>nQc^4woyU#<3ZVi~(s z{TgvQQ5)<>h&MbC#x>}YAobu>IjyUqp8eCLpJKRyab>vMnR>$;p{8 zN=#S$c#%9i+y0t28GJ(B$JEe*5P$*6gg3VlAv4ELPbN(1iwqXsyQOUWKq*C)yBa6m zb3FfnKp?_S^gT#P5GsW*^A z)^#MMD11h6)W+)Q;^o=A(T6!(?EPhFzb^^CRWa9}u$sd?hOM6F-iKSG}IGpS>-cnvMnt@=W#kgbt~k z>M8Z^7fcsQ~{EnO$(b zvR*#?e@nWl7PwCPxb3+{QkQ_sgiPZCC2LJWq4Jqcj_N0}n6OY*1537&V~e1@a|{@~eg>ZwlLswvzf z#Aw_hv0UE0#CV_JZ2SE({BDrxrdHxF1y3|YI!#%;-NqmpjMKQ-@~{ti$N-d*g5BU^ z0)@Nu3uc3|a#Q^Qm>Jy7Jd@o31N|Rs1bXm^asDfvPoH90(sXs9yy?_N2+=p6bBd9%r*BrJy}6aNj-*3kFEQ2vOHk#rjU4T zNgb?^ymyxlRjm)dkQjV3wcJ0Ar1I;&ZoPq*dR?^}#FvxiUf|YN&%OqzTw)z%6%sz| zfjZu8yW1CZ-*L6;b2MYn+uH5L4`4V|R?VrG%AbmlShPmMbDD!}QF80&l>3Lf(Yri0_ z$=10jS?R*wG9dSxI_;Tt1G?Tx@HNOaI_=Ho$zo{r@D;?9cPWu2{4L(X*wy~zwzwsj z<+7Ep^H@C<5TRr}G&YJa-xyi+!XT_a`eL)C0}69*tmG!`nqMx7*ZixB$IG$3LvMxD zmYEFs+1&j5j6Mhnos1e+^fNPmGKO;6v+ACht^;j48)RtSG%5u(Ad{PaDB6TdQ)|-@7v(S?E`W06(`4859bLc*;1XBdU^37Uy#L z5AWdS`JYfIXBU9S;!prB&TXG!GVBjJQ~9J>l+I$lUN~t=XGCqj9-(V3@*0Y&vA?GY z!f6A14Rnad@8sM|HkPu-V0a7YW@Xl+0i)it|F3R$n6+@jd>PSx1ginAKl z`SG+nQMK=nGxvxV*T*3EGn7GUoXcr>3!U$V->k7`a`Y&(0}PHBI~At5oz7c3JGU5HWWu2+zeG`M;( zp#Cx-F{Nud5XnDlrF^9T0L|!bsf$sFjYwH*I0;{FH)kET%kpKlH| zMXkFYJq9YH=^p8648tYIp7mx3mwD84w}V3uy-_cQQ~km;oBKpec;Z=ru6<1=t)Y>b z{_QADY13HM&F|GaMSScv^_Wt0;_R43AGmcTQ=)%^d-w3$Z{@9C&31bX{lI_HcU0T4 zNcs#Q^jGUge~VA{WCwG5y6#N$Etl_0)kF3FiUr#WhVKvR9`3qTR_j%AXO}UYot7kJ z*KomfI>+-owPStA16XwJB1ol!yTQBRg4Do3)*BF)Borj4kf%ITPFrcZ-eDRQic9Eq z3M?FepP`KR{>TZA#QkP^0Xdyy6canvQt@4t%q}8<*uc3rEB_T>))g?h+agG7po9CY zgBuM7zkUFb2NsLiYyXCZ4}!IUWv$C)=`jVCL%D2GQQ+!So2DKCmW@#p_i0;v>8yx1 zmyVJ$A^FO6hI)TzygrcXbHQbK+{MuE6Rne6lT4O%8@1yviteRa_au7n{hd{v+5MJn zBW4kMWnSI!gN!g~!nmqLK{mTDGJ*L??|8@Q+hr*gbyd3e0Sl#kZ=d^fSmwKmx9CuH zjsw8LlrcWZB5qHQVff9wo2_Bv^^1_x*k>~`N^VrPphpn}r65IpL@e4y-Xp8rYn69* zvkquoiTLOLCDW~N`0TqXTDQL_M zkE3CGW@}<;$s%r$l@5@^Fe2s;L8%#DC&=qhxu#EZSL54L7+mK;X9DX&N*)0P?TB#5 zgU+p{ie~m_7EO;@C&;14=n_kF4`i&u4VF#*-0WlJzr*MYmD;_vQ^E+(P7bGmWrmE_ zFKK^YTw<_MDzW%eEIh^BaNqO#7h?WI;Ig|IkvzE|uS;JGHIwo;pu$INNN6+laPXmO z`}Tle7`UqEvg`o;!mflF6h`xK8}-)dZu$+QLsf3>m`u-tgc<_SD`Mkc_*+`< z_L3a!AZ@C7b2XoJqIx6iFFzv9Ps$2j%-=_(uR7?f^+~_dP2IvQu1}MaZ7h+YQ|%) z#o;zFyLFW=D-Tj3O*%?aDC?GnfW&Ted-8SG-T5@SwgR6J> zwhavGm#C0RiGZnP@1GJZhq-=g8i{E6l}reY@`RUp&NXqY6-2n(}fi*4$GmR#O+HGxoS7*C-oh)INr5x}YhVIN{mLgU@Zn zTq*$8o$~|)mseS&tNeSR#?F>AVvioV_xx7{=p}|$ zc|rg_t)FQ-S>9}j#>*RBQd)-b{$Y5!~*JDMNDrU560FZ>cU*( z7Lt1mT3^({v*6lj@jbF~>-u_Ai%B~3wHN^H=D(YWcWda{^Ce(Bs&3j+I1D&|lU8>c z(oKr(;`YqsVMwoW#3Y>EQ_Y=Sp(qaLlY64%!UTGf!mj$YHCwy{wC)-p{Gdlj_2M*Qye`d^5*kt17Byj?OH zw|pCk8*&&+;PP=WHT<{b1nS)Gk}em|?p5{Hb_GZd^o5T&y!D|W8C}Bj=dc($!N=*N z#Zw04Ra2)4828qK9|0p3W7CECqnr|lro*n8z4!qp>0Ufh968}b!#3W6zCy*wgEY%>*?K*H%c)e|oXTH6x!_o!qq#A+Bc1~3! z5(llV$E_SI-M|SYDS|QHFzx%F@=4#V+}tUz zT{P>=_AT1Oq;+hQ?C$U;#!TPcALo!O{4$mE-li5nQ%3?W?Pp(iw}iIQhu0kqPwU;% zzW)jL`V#zwdoiXH8-95aS;?${>_9>0uL0P*oADRyeQEPm{-3b-76^w2CqINjQ^`K# zyXFzyfAZkx0k8ig-}C;b<;>HWfHhf|DO6Fy_M9H^bHWwtAGHKbfN!*+_Dc-?f~IyTK5OcVeG(_!{`KTw*8 z?U|N4fW&sVY;I5{^oQ9=l#CSN$w0o_H-RP>w{!x#Y0P%TKU6}WZaQnmW=`AS3G@dk z25B(bT4n6%Xfhb$Q4~HtYn~@Kp9Vw#?;h73Um$&bkj?*%+unuq{*Z0ik67_RA*G5g+t_0is-2RoNmnD|1^Z*``C(5ncV{5Q4k>*?aw8 z@ScP40A;mYU2v!OjL+mE+<**+C@=aE4@Rtvdk-jw0+S!{w?$(DW#^if?JJR^%QMTZ zqg$zskb9S@+LP?FC3+rQi+nKFgY)%K#NxGW_%?(Iv{h^J=m9*`KBnLPjzvY|nnJ^8 zMN`N3$)|IKD+TVS_fZ|XFN^sY~Q{@Z6I|<&)W;x*gURnKmSv=f*Iz4$}m=wOAUDwUQYM|b_ zgVfBV^}9|bd-XDt*d;(RzYNxe-zg8^Q`Tga`lt;#ZVs-*B%`$bv~{+9ch;)kD!R>8 zcVweO`QgkV^sw1~NIGbrU3LN_6qW-#7xYV;Ik`%1*SA$kZ;&&-yE)9ewq|kX`qZK+ zrwwq0SW1N;+EGcZcH|EAY9^JUJ7iMPH4hMzsKqCLDPiX4o(MlYh>j7RIm425?=7dI zmJX_5Hp3@-*AZ$%M2TZSwYI=Q$k1^jPZ-x5U|_#Tj~z-LA37sd8dl?`x?p!|%RVO}=lxc!cYDU{n->_k7XF+%hYq@uGO%dbcxf+nV9z1*BxA zMPN{wg>dsK57Bo)K71R&{BY-zK^|_D(V1L04h5m|2VY#RrbaN|Pzb9rym^1IvEe?v zhQ^Mvdt{G`Y7)qjqp}&bD{|z@cumSw1sMK5rouq_X^$D0N>UB#CRNLdq6d&`9Dr0j z!-<$SA87)yzj!WlOLWxl#+rUp2Tvf)i8pUep_^|h<;}Nm#KKCQq1wD8t)tAlqpc&9 z2A#`+DK_Qyv>0h#LKHr}Je)qA*<(UeVM1X>L*kPu=R5oS3%EsLW@VHeSO=|nnprla z=U}{^s?_EbvhIjM@P1D((@8~29DO`TIfQ&}5C7$o##|dIkT2Sa<9U`48O-pd@W zT{c`Zj~%d+-JHk?adopQ+-8F zj&gUE7yJFpY}*vZuM1UDl%Oi0Gv;4&`u{=j=?cHKm`lk5Y#HO8Z z0aQ%Q;nvh+se0keQc2w9mAKF09XcWDq$6KcNHFbf!<*L|Cgp32(;8DqyFDYuy|1Ct zZH_*`Fh1CWF#FLc<%x3}&0%Pwt>7|9!R~&-3KmsT4uys!EkdPBO0>=%O z{yf)m7pbWB&{Y#Fk_XQ@0j0*t?;c4N*<(kj6O=x@QmF!8+o2a+i zK#D`{)IHJlKF#W=V6N@ixgq2J!2v5_Rp3*j`eim&e#Jm`hCqzT*p;B_WJe)gJ1TE_ z3`qN=X96&eII0488*m|3XN%^CAeJwqT;d;O-zm!BHJw0G@Fv|$l`X;|Rdls4JKkl= z{xJri*-*Ap(YrCR;W)~@`U4y9BEAbvqexVfA!pS5{#cu>YYsCV=knPm;)&k92JrJv zvrM;pHGUu6J5b#syl^(Je-XnjjX-hbc-zC+3Zox!!YPyWckDkEbejf4EvpwK(!tWJw3AY)rsdHD=IxD_n%Y41YjBcwSnb-Sk`8`^P1_)_XBWArh0sua3YvHrIBE`&J6CHqG1v>L7>ZV~tK%3$-ZeGAx zP}dYsHUa>}TwLVr2!$kpgf^_EBr^HG45acS=w|}Jz0K3SuETCRDMV+0c8Z=7;Bn2h zJ4?1QKCa4j%vOFcgmpXI{6(JfAXj5*0l8W708Cf6pk{?(N4>>q>D{yOz<?llGjLZPJ1oas~wK{z!0QmMh{15rxSndni2)Y6`Ol1)YMWeBO;qIrFA7@2i z?j{5p0GwGnmCBK^?EPN8NM{X0_MQYd!Qz9C3C-1f+PktWBKFC(P;6Bf!Z7?IlS82{ z5Bp5-yVFb%^c*|lP{XElh-{uF)F#k8p=8x-X0li5I+JsBS9gYIqS?8Wjl}^+^X0YX z*}V>3ovG2Flr7Pt^J9q#B7}F{RL4?874Tp9nD?V6Ki?FT|BJnSSoKPIeuCb!=JDRv z1jtm5OspL0A!q%SZ@-5D&>6lR#(;;X!xiDtkkC1deo!N4EWTUD+D^Je3F}Ho`Ny1A z2Af~6HuslVm^uVeK9h+kAQ8?}lxTEr(VchM(GRhofw z#>iJT30_L`^2GLirtk4P^}oN*3zSWd`}!Y+?qlZ8Zm^wj<${+>uN@&C zN7IG_-s?-w)V$>#lGohoSA+3l&jXclB)Z193jZgQCVSy0WIFWQ zd8%P_+}F=aCoW_1ozO(M>QvRnd!V+auR_nw@NPI(}+FSJYn#A2+1Guv70-ni{PJQ!V4fmbQ6sfBSU9L4!luzHy5SbM{49sq&tCg0Lc) zJ8hCDt=?;SHZONc_U;DC83NjhHAL`qZ$a==@~P0{B~$9*Oqqi=iPq#Wr*-bs@{Gyh z`+Z@&!(gm#TIsKUf`Q%ctuwqWO>YLb!%#F+_d!M9PjkXz*7vh0G_8j+pQ^rdNM@_5 zX{^|CxW^studzGBQD4wAc>2D@xfyo=Bu|@^x4MV#`6M}A`AyEcpBZhV0$OJ$*${e2 z7O-%=e3V)BoXa(7NCFp_8UL9GNaGJXJk_*CW0Fm$ONYf z%YaGAu_9gT@`~UPR;yY6>zF7ZE47zRlha7 z^9CL$*ARQO4%Pg|Zn8u4>eRMBuA7Y1&eVTNt^2(g&6Va&UMKEjfb`i2-Ee9f-rlK` z7gwsowk~YioEDuTs^BpH4^^*n!q5Lk^p0qWny=#DT&)2 zpSX0?pK0|DGm*!%96FW@*0V1YFmr0-r7VxbxVx9oV}e_g?) zZHqs7O!JEU;(!MKBr%JS`YuX(^v;9R<3FHHPy;s2b~o{4ka)7I8m^)cx3|@yOo=LOMTR)j^_R_? zs-AC>F6cNY{jmttyC}bJ>_T7la~I3xA11o2+(l^T=X1>HuZz16q#`HQvQ0UO#!!u* z?Pm}~5*kb6Rwp$=rkaP-3Ci0)?LMN>JH}UXC35smq&iy3HpPIdzt#mlYGVajqw_H~ zdu&3E%Ia3gH$cjUOS-swj?XWi&Dy28-zcYpW=+f?UY!paYn{9|zi#ue>xK##9&2n; zTL03?n_mxM%%IemFEN6_C=EElYtM6-0bh4eef{_I z`)k0AXkpn!?sJ-sH7aq>cmu4(C4zmfre{sjTVtbps$MDt@nXZItoo>x;*wq#Hi@Yqltp~xwTjdkUjSr7zcco<;8@unz zwWk-SyCTTyjLWv~X(Z^T-GmGCKuS-IH$T#t7?D$r&t>wOQZ$KAN-Whe^5rRdKhxoo zYxzdmJ?^K-4lzjHWi1d(Y})PUd_810t&{B4-;~5l->TXafC$8_pw4#h4>%%~RqW&w zOif=5jFOT+b)YQSmJki9wVMOccZ^@qp(7eT-k7^GwR%5UBsAdcM~7g|{6NwyU$wU( zStg}cm@7WVY^G{#{4pQsUyZ6vd%NDx{J&@0-|=v1ZBsoHlc@QU%1w0XJK*ag;u^x{ z?Blm{tM1hqJv-R7er4n#+I@+UK@g*EYFdx*o#%dZxQd{a-Cr61B{C3&K_wTajMq)v z@lDG4KA__OyJkjnhamX!2SX|z52vz{>mjJ(N-wf(fSfpN{cN=Ls1#6AqTM-=L8t}x zcVZV!uIfuN+buHRH;DR6-f!1Uzzp^Uw*uxfIk2&qA99?}sgX09PJ!I+34uuDC5%L4 zQ{HVo9l_A(UdfvW$$hEv;D7{*&4=ImX6{g*DYpmoMTR+xoL}E#8ru2y*ldsQxWaLY zKyvgLkedv0^~9lbmmVrW2>ZMX*VKzu5Wb)34UN=v*IKI1LR3!_6Eb*RHt+4})hqUw zqQ&-U?M-(8UzSJp(qnM@)qwC;hbr$4FMA@YOgMbUVyL z_CI%U*$D#gfc;HS!!YwtVE0o6oW}^@9a?K>F4j6BmjG^m7??5gf4=JF-DGO%afgC2 zjT-Fl7+o8en{$-u1+9dgYF1=rV_w?m5eYZeU-kwyw5?|izG*{Db5RaFH#IR6K`Qa* zV9AMziJR<5i@|8O5LgVo`9GKS<9!;+{~4$LpYm+sz9)D=Z?e%}KOO_2=NA{2`CKNb H_w9cH9vllY literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md index e66636074fc..26c32b87bc3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,7 +14,7 @@ **GamerBook Pro Max is a desktop application for managing your gamer friends' contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface). -* If you are interested in using GamerBook Pro Max, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start). +* If you are interested in using GamerBook Pro Max, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#installation-and-quick-start). * If you are interested about developing GamerBook Pro Max, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.