Skip to content

Commit

Permalink
Merge pull request #123 from JonathanLeeWH/update-documentation
Browse files Browse the repository at this point in the history
Update UserGuide.adoc to match updated export command implementation
  • Loading branch information
flxffy authored Mar 26, 2019
2 parents 7acc3d5 + 4c6ad2e commit 8f0c7b5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you are looking for a medicine stock taking application for clinics, MediTabs

== Quick Start

. Ensure you have Java version `9` or later installed in your Computer.
. Ensure you have Java version `9` installed on your computer.
. Download the latest version of `meditabs.jar` link:{repoURL}/releases[here].
. Copy the `meditabs.jar` file to the folder you want to use as the home folder for your MediTabs application.
. Double-click the file to start the app. The GUI should appear in a few seconds.
Expand Down Expand Up @@ -261,7 +261,7 @@ A sample image of how the Medicine Inventory data in the exported CSV file is or
image::SampleCSVFileImage.png[width="790"]

[NOTE]
From the image above, you can observe that different batches of the same medicine have their own row in the CSV file. This provides more detailed information on the quantity and expiry date for each batch of the same medicine as different batches of the same medicine can have different expiry dates and quantity.
From the image above, you can observe that different batches of the same medicine have their own row in the CSV file. This provides more detailed information on the quantity and expiry date for each batch of the same medicine as different batches of the same medicine can have different expiry dates and quantity. Furthermore, the CSV file also includes information such as which medicines are low in stock and which medicines are expiring soon for easier reference.

=== Printing labels : `label`

Expand Down Expand Up @@ -386,10 +386,24 @@ _{explain how the user can enable/disable data encryption}_

== Frequently Asked Questions (FAQ)

*Q*: Where can I find Java version `9`? +
*A*: You can download Java version `9` link:https://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase9-3934878.html[here]. We recommend installing Java SE Development Kit `9.0.4` on your computer.

*Q*: (Windows Only) I followed the instructions in <<Quick Start>> but the GUI did not appear? +
*A*: This is a commonly known issue with JDK on Windows. You can learn more about the issue here: link:https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4912211[Link]

We recommend following the steps below to solve this issue:

. Ensure that you *only* have Java version `9` installed on your computer. Uninstall any other versions of Java which might be present on your computer.
. Download the latest version of `jarfix.exe` link:https://johann.loefflmann.net/en/software/jarfix/[here]
. Double-click the file to allow the program to fix this issue.

[NOTE]
If you encounter any problems running `jarfix.exe`, you can read the documentation available on the link:https://johann.loefflmann.net/en/software/jarfix/[website] for more detailed instructions on how to run the program on your computer.

*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 MediTabs folder.


== Commands Summary

* *Add* `add n/NAME c/COMPANY_NAME [t/TAG]...` +
Expand Down
Binary file modified docs/images/SampleCSVFileImage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8f0c7b5

Please sign in to comment.