diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 55e5cf236a2..64769bdfdc0 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,8 +3,7 @@ layout: page title: User Guide --- -AddressBook Level 3 (AB3) 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). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. - +Welcome to HouseKeeping Hub, the premier **desktop solution for managing client and housekeeper contacts**. Combining the **efficiency of a Command Line Interface ([CLI](#cli)) with the convenience of a Graphical User Interface ([GUI](#gui))**, HouseKeeping Hub offers unparalleled speed and ease of use. Whether you're a typist or a clicker, HouseKeeping Hub ensures swift completion of all your contact management tasks. Bid farewell to the sluggishness of traditional GUI apps - with HouseKeeping Hub, managing your contacts has never been faster or simpler. * Table of Contents {:toc} @@ -16,18 +15,18 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo 1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +1. Copy the file to the folder you want to use as the _home folder_ for your HouseKeeping Hub. -1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
+1. Open a command [terminal](#terminal), `cd` into the folder you put the [jar](#jar) file in, and use the `java -jar addressbook.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](./docs/images/Ui.png) + ![Ui](./images/Ui.png) 1. 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: * `list` : Lists all contacts. - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. + * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to HouseKeeping Hub. * `delete 3` : Deletes the 3rd contact shown in the current list. @@ -67,7 +66,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo Shows a message explaning how to access the help page. -![help message](./docs/images/helpMessage.png) +![help message](./images/helpMessage.png) Format: `help` @@ -76,7 +75,7 @@ Format: `help` Adds a client or housekeeper to the address book. -Format: `add TYPE n/NAME e/EMAIL p/NUMBER a/ADDRESS [t/TAG]…​` +Format: `add TYPE n/NAME e/EMAIL p/PHONE_NUMBER a/ADDRESS [t/TAG]…​` Notes: `TYPE` can be either 'client' or 'housekeeper' @@ -133,15 +132,15 @@ Format: `exit` ### Saving the data -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +HouseKeeping Hub data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. ### Editing the data file -AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +HouseKeeping Hub data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
:exclamation: **Caution:** -If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. +If your changes to the data file makes its format invalid, HouseKeeping Hub will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
+Furthermore, certain edits can cause the HouseKeeping Hub to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
@@ -150,7 +149,7 @@ Furthermore, certain edits can cause the AddressBook to behave in unexpected way ## FAQ **Q**: How do I transfer my data to another Computer?
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous HouseKeeping Hub home folder. -------------------------------------------------------------------------------------------------------------------- @@ -158,7 +157,7 @@ Furthermore, certain edits can cause the AddressBook to behave in unexpected way Action | Format, Examples --------|------------------ -**Add** | `add TYPE /name NAME /email EMAIL /country_code CODE /number NUMBER /address ADDRESS …​`
e.g., `add client /name Elon /email elon@gmail.com /country_code +60 /number 88888888 /address Elon Street, Block 123, 101010 Singapore` +**Add** | `add TYPE n/NAME e/EMAIL p/PHONE_NUMBER a/ADDRESS …​`
e.g., `add client n/Elon e/elon@gmail.com p/88888888 a/Elon Street, Block 123, 101010 Singapore` **Clear** | `clear` **Delete** | `delete INDEX`
e.g., `delete 3` **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` @@ -170,15 +169,23 @@ Action | Format, Examples ## Glossary **JAR** + : JAR stands for Java Archive. It is based on the ZIP file format that is commonly used to store java programs. **CLI** + : CLI stands for Command Line Interface. It refers to programs that are primarily **text-based** where users interact with the program by typing **commands**. As such, users will use their keyboards more, in contrast to a Graphical User Interface (GUI) where users will use their mouse to interact with the graphical elements. +**GUI** + +: GUI stands for Graphical User Interface. It refers to programs that are primarily **graphical** where users interact with the program by clicking on **buttons** and **menus**. + **Terminal** + : A terminal is a Command Line Interface (CLI) that allows users to interact with computers by executing commands and viewing the results. Popular terminals in mainstream operating systems include command prompt (CMD) for windows and Terminal in macOS and Linux.
+ **CMD**
drawing
**Terminal (macOS)**
diff --git a/src/main/resources/view/DarkTheme.css b/src/main/resources/view/DarkTheme.css index bbfca0ba0b5..f3490158500 100644 --- a/src/main/resources/view/DarkTheme.css +++ b/src/main/resources/view/DarkTheme.css @@ -163,6 +163,8 @@ -fx-pref-width: 500; -fx-max-width: 1000; -fx-max-height: 200; + -fx-min-height: 100; + -fx-pref-height: 100; } .result-display .label {