You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**Java**| A programming language. Various versions can be downloaded from [here](https://www.oracle.com/sg/java/technologies/downloads/). |
112
-
|**home folder**| The main folder where all app activity can take place and files can be stored |
113
-
|**command terminal**| A text-based interface to your computer.<br>On Windows, this can be opened by pressing the Windows key, and searching for an app called "Command Prompt".<br> On iOS, this can be opened by pressing Command + Space, typing in "terminal", then pressing "Return". |
114
-
|`cd`| A Linux (operating system) command used to navigate to different folders in your command terminal. Stands for "change directory".<br>Linux tutorials can be found [here](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview). |
115
-
|**GUI**| Short for "Graphical User Interface". The digital interface in which user interact with graphical components, such as icons and buttons. |
116
-
|**CLI**| Short for "Command Line Interface". A software mechanism you use to interact with the application using your keyboard. |
|**Java**| A programming language. Various versions can be downloaded from [here](https://www.oracle.com/sg/java/technologies/downloads/). |
112
+
|**home folder**| The main folder where all app activity can take place and files can be stored |
113
+
|**command terminal**| A text-based interface to your computer.<br>On Windows, this can be opened by pressing the Windows key, and searching for an app called "Command Prompt".<br> On MacOS, this can be opened by pressing Command + Space, typing in "terminal", then pressing "Return". |
114
+
|`cd`| A Linux (operating system) command used to navigate to different folders in your command terminal. Stands for "change directory".<br>Linux tutorials can be found [here](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview). |
115
+
|**GUI**| Short for "Graphical User Interface". The digital interface in which user interact with graphical components, such as icons and buttons. |
116
+
|**CLI**| Short for "Command Line Interface". A software mechanism you use to interact with the application using your keyboard. |
ImmuniMate is a desktop application for healthcare professionals and staff to better store and manage their patients' personal and medical information.
122
+
ImmuniMate is a **desktop application** for healthcare professionals and staff to better store and manage their patients' personal and medical information.
123
123
It is optimised for a single user on a single computer, meaning that after downloading a copy on your computer and using it, your copy cannot be accessed through other computers over the Internet.
124
124
125
-
ImmuniMate is compatible with Windows, Linux and MacOS operating systems, and installation does not require any additional installers.
125
+
ImmuniMate is compatible with **Windows, Linux and MacOS** operating systems, and installation does not require any additional installers.
126
126
It has an eye-catching GUI to capture your attention, but despite that, all interactions with ImmuniMate happen through the command line interface (CLI).
127
127
This means each feature of ImmuniMate is only accessible through typing a command into the command box in its specified format, and pressing "Enter" to get a response.
128
128
129
129
Here is a graphic on components of the GUI and their functions:
The list of commands and their formats are specified below:
135
136
136
137
### Command summary
@@ -151,7 +152,8 @@ The list of commands and their formats are specified below:
151
152
|**[Help](#viewing-help-help)**|`help`|
152
153
|**[Exit](#exiting-the-program-exit)**|`exit`|
153
154
154
-
155
+
<br>
156
+
<br>
155
157
The list of fields and their formats are specified below:
156
158
157
159
### Field summary
@@ -175,7 +177,7 @@ The list of fields and their formats are specified below:
175
177
|**Diagnosis**|`d/`| Any text. Blank or empty text is not accepted. | No |
176
178
|**Date of visit**|`dov/`|`yyyy-MM-dd` format. | No |
177
179
178
-
## Error Messages
180
+
###Error Messages
179
181
180
182
Sometimes, **you might type in commands in the wrong format**, or fields that don't make sense, and that's fine.
181
183
When that happens, the erroneous command you typed will light up in red, while more details on the nature of the error will be shown in the feedback box, like in the picture below.
@@ -196,34 +198,34 @@ Find retyping commands a hassle? Use your 'Up' and 'Down' arrow keys to access y
196
198
197
199
1. Ensure you have Java `11` or above installed in your computer.<br>
198
200
199
-
<divmarkdown="block"class="alert alert-success">
200
-
201
-
**:bulb: Tip:**<br>
202
-
Don't worry if you don't have Java 11 installed yet!
203
-
The Java Development Kit (kind of like an installer) can be downloaded from [here](https://www.oracle.com/sg/java/technologies/downloads/#java11).
204
-
Take great care in downloading the one which suits your operating system (Linux, Windows, MacOS etc).
205
-
</div>
201
+
<divmarkdown="block"class="alert alert-success">
202
+
203
+
**:bulb: Tip:**<br>
204
+
Don't worry if you don't have Java 11 installed yet!
205
+
The Java Development Kit (kind of like an installer) can be downloaded from [here](https://www.oracle.com/sg/java/technologies/downloads/#java11).
206
+
Take great care in downloading the one which suits your operating system (Linux, Windows, MacOS etc).
207
+
</div>
206
208
207
-
209
+
208
210
209
211
2. Download the latest `immuniMate.jar` from [our website](https://github.com/AY2324S2-CS2103T-T08-1/tp/releases).
3. Copy the file to the folder you want to use as the _home folder_ for your ImmuniMate.
214
216
215
217
4. Open a command terminal, and `cd` into the folder you put the jar file in.<br>
216
218
217
-
<divmarkdown="block"class="alert alert-success">
218
-
219
-
**:bulb: Tip:**<br>
220
-
`cd` is a Linux command. New to Linux? You can learn the basics fast from [here](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview).
221
-
</div>
219
+
<divmarkdown="block"class="alert alert-success">
220
+
221
+
**:bulb: Tip:**<br>
222
+
`cd` is a Linux command. New to Linux? You can learn the basics fast from [here](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview).
223
+
</div>
222
224
223
225
5. Type `java -jar immuniMate.jar` and press "Enter" to run the application.<br>
224
226
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data. The colored circle on the right of each patient's name is the status indicator. For more information about the status indicator, see [create](#creating-a-patient-profile-create).<br>
225
227
226
-
228
+
227
229
228
230
6. 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>
229
231
Some example commands you can try:
@@ -238,12 +240,12 @@ Take great care in downloading the one which suits your operating system (Linux,
238
240
239
241
*`exit` : Exits the app.
240
242
241
-
<divmarkdown="block"class="alert alert-success">
242
-
243
-
**:bulb: Tip:**<br>
244
-
Refer to the [Features](#features) section below for details of each command.
245
-
246
-
</div>
243
+
<divmarkdown="block"class="alert alert-success">
244
+
245
+
**:bulb: Tip:**<br>
246
+
Refer to the [Features](#features) section below for details of each command.
Creates a patient profile in ImmuniMate. A patient profile refers to a record of a patient with a set of relevant information. For the complete field of information, refer to the [Field summary](#field-summary) at the end of this User Guide.
298
+
**Creates a patient profile in ImmuniMate.**
299
+
300
+
<divmarkdown="block"class="alert alert-info">
301
+
302
+
**:information_source: Notes**<br>
303
+
A patient profile refers to a record of a patient with a set of relevant information. For the complete field of information, refer to the [Field summary](#field-summary) at the end of this User Guide.
* NRIC must be that of a patient already in ImmuniMate.
@@ -560,7 +568,7 @@ Example:
560
568
561
569
### Cluster finding: `cluster`
562
570
563
-
Shows whether or not the number of people **unwell** with the illness given (diagnosis in profile) in the location given is at least the integer given, and lists the people there with the illness.
571
+
**Shows whether or not the number of people _unwell_ with the illness given (diagnosis in profile) in the location given is at least the integer given, and lists the people there with the illness.**
1. The Command History only saves valid commands, it does not save commands that were unsuccessful.
616
-
2. The Command History is temporary and will not be stored in between sessions. When you close an instance of ImmuniMate, your Command History is cleared.
623
+
1. The Command History only saves **valid commands**, it does not save commands that were unsuccessful.
624
+
2. The Command History is **temporary** and **will not be stored in between sessions**. When you close an instance of ImmuniMate, your Command History is cleared.
0 commit comments