Skip to content

Commit

Permalink
Merge pull request AY2425S1-CS2103T-T12-4#127
Browse files Browse the repository at this point in the history
Update 'save' and 'load' commands in User Guide
  • Loading branch information
JJtan2002 authored Oct 24, 2024
2 parents 0bb2608 + f20b91f commit e948aa3
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
title: "User Guide"
pageNav: 3
---
# Gamerbook PRO MAX User Guide
# GamerBook Pro Max User Guide

GamerBook Pro Max 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, GamerBook can get your contact management tasks done faster than traditional GUI apps.
GamerBook Pro Max 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).
This app is useful for gamers who have many friends online across different games.
If you can type fast, GamerBook can get your contact management tasks done faster than traditional GUI apps.


<!-- * Table of Contents -->
Expand All @@ -15,13 +17,13 @@ GamerBook Pro Max is a **desktop app for managing contacts, optimized for use vi

## Quick start

1. Ensure you have Java `17` or above installed in your Computer.
1. Ensure you have Java `17` or above installed in your Computer. You can check your Java version by opening a command terminal (e.g. Command Prompt) and typing `java -version`.

1. Download the latest `.jar` file from [here](https://github.com/AY2425S1-CS2103T-T12-4/tp/releases).

1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar Gamerbook.jar` command to run the application.<br>
1. Open a command terminal, use `cd` to nvaigate into the folder you put the jar file in, and use the `java -jar GamerBook.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>
![Ui](images/Ui.png)

Expand Down Expand Up @@ -173,19 +175,31 @@ Exits the program.

Format: `exit`

### Saving the data
### Data storage

AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
GamerBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`.

GamerBook data are saved in the hard automatically after any command that changes the data.

GamerBook data are loaded from `[JAR file location]/data/addressbook.json` automatically when you open the app.

### Saving the data file : `save`

Manually saves the data in another JSON file `[JAR file location]/data/save.json`.

### Loading the data file : `load`

Manually loads the data from JSON file `[JAR file location]/data/save.json`.

### 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.
GamerBook 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.

<box type="warning" seamless>

**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.<br>
Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside 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, GamerBook 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.<br>
Furthermore, certain edits can cause the GamerBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
</box>

### Archiving data files `[coming in v2.0]`
Expand Down Expand Up @@ -220,3 +234,5 @@ Action | Format, Examples
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
**Save** | `save`
**Load** | `load`

0 comments on commit e948aa3

Please sign in to comment.