Skip to content

Commit

Permalink
Merge pull request #337 from Ruizhi2001/branch-touch-up-ug
Browse files Browse the repository at this point in the history
Branch touch up ug
Ruizhi2001 authored Nov 15, 2023
2 parents 9cfef8e + e902058 commit 6e54619
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
@@ -63,7 +63,7 @@ FoodNotes is available for the Linux, Unix, Windows and Mac OS operating systems
&nbsp;&nbsp;&nbsp;&nbsp;5.3 [Stall Sorting Commands](#stall-sorting-commands) <br>
&nbsp;&nbsp;&nbsp;&nbsp;5.4 [Stall Finding Commands](#stall-finding-commands) <br>
&nbsp;&nbsp;&nbsp;&nbsp;5.5 [Item Management Commands](#item-management-commands) <br>

6. [FAQ](#faq) <br>

---

@@ -171,10 +171,10 @@ Positive integers are whole numbers greater than zero, e.g. 1, 2, 3, 4, 5, etc.

3. Copy the file to the folder you want to use as the _home folder_ for your FoodNotes.

![preloadStalls](images/UserGuide/steps.png)
![steps](images/UserGuide/steps.png)
4. Enter your _home-folder_ and right-click on the downloaded jar file as shown.
5. Select on the "New iTerm2 Tab here" option, (or any other terminal option you have) to open a terminal window in the folder.
![preloadStalls](images/UserGuide/run.png)
![run](images/UserGuide/run.png)
6. Run the command `java -jar FoodNotes.jar` in the terminal window.

7. FoodNotes will now launch and show a list of preloaded stalls.
@@ -972,7 +972,21 @@ Outcome:
| **Edit item** | `edit-item s/STALL_INDEX i/ITEM_INDEX [n/ITEM_NAME] [p/ITEM_PRICE] [r/ITEM_RATING] [d/ITEM_DESCRIPTION]` <br> e.g. `edit-item` s/1 i/1 p/5.00 |
| **Review item** | `review-item s/STALL_INDEX i/ITEM_INDEX r/ITEM_RATING d/ITEM_DESCRIPTION` <br> e.g. `review-item` s/1 i/1 r/5 d/Flavorful | |
| **Delete item review** | `delete-item-review s/STALL_INDEX i/ITEM_INDEX` <br> e.g. `delete-item-review` s/1 i/1 |
## 6. FAQ<a id="faq"></a>

**Q:** Can I use FoodNotes without prior experience with CLI (Command Line Interface) applications? <br>
**A:** Yes, FoodNotes is designed to be user-friendly, even for those unfamiliar with CLI applications. The user guide includes explanations of all commands and their syntax, making it accessible for beginners.

**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 FoodNotes home folder.

**Q:** How can I export or backup my FoodNotes data? <br>
**A:** Currently, FoodNotes does not support direct data export or backup. We recommend manually backing up the database file from the application directory.

**Q:** Do I need to manually save my data? <br>
**A:** No, FoodNotes automatically saves your data after any command that changes the data. There is no need for you to save manually.

**Q:** Can I run FoodNotes on my mobile device? <br>
**A:** No, FoodNotes is currently only available for Windows, Mac and Linux operating systems.

--------------------------------------------------------------------------------------------------------------------

0 comments on commit 6e54619

Please sign in to comment.