Skip to content

Commit

Permalink
docs: Update UG
Browse files Browse the repository at this point in the history
  • Loading branch information
annoy-o-mus committed Apr 15, 2024
1 parent bd1bf1c commit ba4191f
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@ Format: `save [-o saveFile]`

Examples:
- `save`: Save the file to the default location.
- `save -o data/testfolder/output.json`: Saves the file
- `save -o data/testfolder/output.json`: Saves the file to specified location.

The default save location is `data/MediTrackerData.json`.
As far as possible, refrain from using spaces in the file path, especially with `-h` i.e. `path/to -h/`.
Expand All @@ -756,6 +756,12 @@ Also, ensure that the file does not end with a space or a dot (.); the file must

Ensure that the folder you are going to write to has the proper access rights. Don't write to system folders; it will likely fail.

<div class="info-box">
:information_source: <strong>Info: </strong>
The <code>dailymed</code> folder will be created at the same level as that of the JSON file.
Keep both the folder structure and the file name as is as our loading functionality relies on this particular save format.
</div>

<br>

<div style="page-break-after: always;"></div>
Expand Down Expand Up @@ -785,6 +791,12 @@ This will trigger the help message to be displayed rather than processing the sa

A prompt will then ask for your confirmation to overwrite existing data as an additional layer of safeguard.

<div class="info-box">
:information_source: <strong>Info: </strong>
The <code>dailymed</code> folder must be at the same level as that of the JSON file or the program will fail to find the files needed to load
to upated the Daily Medications.
</div>

<div class="warning-box">
:warning: <strong>Warning: </strong>
Loading will overwrite existing running data, so be sure to save a copy first before deciding to overwrite.
Expand Down Expand Up @@ -841,8 +853,8 @@ not display anything at all.

## Setting an arbitrary time

This feature is intended for developers to test out the features. See the developer guide (To be updated) for more detailed explanation on its implementation.
To make use of this feature, simply add the following flag and argument **when running the program** (not during the program execution itself)
This feature is intended for developers to test out the features.
To make use of this feature, simply add the following flag and argument **before running the program** (not during the program execution itself)

Example: `java -jar meditracker.jar -sim 2024-01-01T13:00:00Z`

Expand All @@ -851,6 +863,8 @@ or else the parser will return an error. The supplied time is of the format `YYY

In the above example, it will set the time for the program to be **1 Jan 2024, 1pm**.

The time will be fixed and will not "move" once the time has been set.

<br>

<div style="page-break-after: always;"></div>
Expand Down

0 comments on commit ba4191f

Please sign in to comment.