forked from nus-cs2103-AY2223S2/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #47 from jeraldkiew/update-UG
update UG, remove AB3
- Loading branch information
Showing
1 changed file
with
21 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +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. | ||
MedInfo is a **desktop app for managing patients, 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, MedInfo can get your patient management tasks done faster than traditional GUI apps. | ||
|
||
- Table of Contents | ||
{:toc} | ||
|
@@ -14,24 +14,22 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo | |
|
||
1. Ensure you have Java `11` or above installed in your Computer. | ||
|
||
1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). | ||
1. Download the latest `medinfo.jar` from [here](https://github.com/AY2223S2-CS2103T-T12-2/tp). | ||
|
||
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 MedInfo. | ||
|
||
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.<br> | ||
1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar medinfo.jar` command to run the application.<br> | ||
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br> | ||
 | ||
|
||
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.<br> | ||
Some example commands you can try: | ||
|
||
- `list` : Lists all contacts. | ||
- `list` : Lists all patients. | ||
|
||
- `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. | ||
- `add nric/S1234567A name/John Doe cond/Ligma` : Adds a patient named `John Doe` to MedInfo. | ||
|
||
- `delete 3` : Deletes the 3rd contact shown in the current list. | ||
|
||
- `clear` : Deletes all contacts. | ||
- `delete nric/S1234567A` : Deletes the newly added patient named `John Doe`' | ||
|
||
- `exit` : Exits the app. | ||
|
||
|
@@ -51,23 +49,24 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo | |
- Items in square brackets are optional.<br> | ||
e.g `n/NAME [cond/CONDITION]` can be used as `n/John Doe cond/Ligma` or as `n/John Doe`. | ||
|
||
- Items with `…` after them can be used multiple times including zero times.<br> | ||
e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. | ||
[//]: # 'Might be used in future features' | ||
[//]: # '- Items with `…` after them can be used multiple times including zero times.<br>' | ||
[//]: # ' e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.' | ||
|
||
- Parameters can be in any order.<br> | ||
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. | ||
|
||
- If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.<br> | ||
e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken. | ||
e.g. if you specify `nric/S1234567X nric/S1234567A`, only `nric/S1234567A` will be taken. | ||
|
||
- Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br> | ||
- Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, and `exit`) will be ignored.<br> | ||
e.g. if the command specifies `help 123`, it will be interpreted as `help`. | ||
|
||
</div> | ||
|
||
### Viewing help : `help` | ||
|
||
Shows a message explaning how to access the help page. | ||
Shows a message explaining how to access the help page. | ||
|
||
<!-- INSERT SCREENSHOT PREVIEW HERE --> | ||
<!--  --> | ||
|
@@ -166,8 +165,14 @@ _Details coming soon ..._ | |
|
||
## FAQ | ||
|
||
**Q**: How do I transfer my data to another Computer?<br> | ||
**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 MedInfo home folder. | ||
**Q**: I keep forgetting the commands, is there a quick way to get help?<br> | ||
|
||
**A**: Yes! Entering the `help` command will show a message explaining how to access the help page. | ||
|
||
[//]: # 'Coming soon' | ||
[//]: # '**Q**: How do I transfer my data to another Computer?<br>' | ||
[//]: # | ||
[//]: # '**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 MedInfo home folder.' | ||
|
||
--- | ||
|
||
|