Skip to content

Commit

Permalink
Merge pull request #246 from prawnzyy/branch-update-documentation
Browse files Browse the repository at this point in the history 
Branch update documentation
  • Loading branch information
@dhruvir29
dhruvir29 authored Nov 15, 2023
2 parents 4d1f115 + e445759 commit 955c960
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pageNav: 3
---

# [Ba]king [Br]ead User Guide
Welcome new bakers!
Welcome **new bakers**!
If you're feeling overwhelmed by the chaos of baking, fret not because [Ba]king [Br]ead is here to save the day!
We're here to help you manage the overwhelming number of ingredients in your kitchen and the endless recipes you have stored,
making your baking experience a lot smoother!
Expand Down Expand Up @@ -99,6 +99,8 @@ New to [Ba]king [Br]ead? Not to worry, simply follow the instructions below to g

4. Double-click on the jar and a GUI similar to the one below should appear in a few seconds. If this does not work for you, check the [FAQ](#faq)

5. Some sample data has been preloaded into the application

![Ui](images/Ui.png)

### Navigating the GUI
Expand Down Expand Up @@ -215,12 +217,12 @@ Examples:

Example Used: `add n/Flour q/1 u/kg` **Note**: Sample started with 3kg of Flour in the stock.

<img src='images/ug-images/addIngredient.png' width='650'>
<img src='images/ug-images/addIngredient.png' width='650' height="400" class="center">


Example Used: `add n/Milk q/600 u/g` **Note**: Sample did not have any Milk in the stock.

<img src='images/ug-images/addIngredientNew.png' width='650'>
<img src='images/ug-images/addIngredientNew.png' width='650' height="480" class="center">


### Using up ingredients : `use`
Expand Down Expand Up @@ -248,11 +250,11 @@ Examples:

Example Used: `use n/Milk q/600 u/g` **Note**: Sample started with 1kg of Milk in the stock.

<img src='images/ug-images/useIngredient.png' width='650'>

<img src='images/ug-images/useIngredient.png' width='650' height="480" class="center">

<br>
<box type="warning">
If you try to use an ingredient which is not in the stock, the error message "Ingredient does not exist in Inventory" will appear. <br>
If you try to use an ingredient which is not in the stock, the error message "Ingredient does not exist in Inventory" will appear.
Only ingredients already in the stock can be specified when using this command.
</box>

Expand All @@ -276,7 +278,7 @@ Examples:

Example used: `stock butter`

<img src='images/ug-images/stock.png' width='650'>
<img src='images/ug-images/stock.png' width='650' height="480" class="center">


### Clearing all ingredients from ingredient stock : `clear`
Expand All @@ -287,7 +289,7 @@ Format: `clear`

Example used: `clear`

<img src='images/ug-images/clear.png' width='650'>
<img src='images/ug-images/clear.png' width='650' height="480" class="center">


### Listing all Recipes : `list`
Expand All @@ -298,7 +300,7 @@ Format: `list`

Example Used: `list`

<img src='images/ug-images/list.png' width='650'>
<img src='images/ug-images/list.png' width='650' height="480" class="center">


### Viewing Specific Recipes : `view`
Expand All @@ -315,7 +317,7 @@ Examples:

Example Used: `view 1`

<img src='images/ug-images/view.png' width='650'>
<img src='images/ug-images/view.png' width='650' height="480" class="center">

<box type="info">

Expand Down Expand Up @@ -373,7 +375,7 @@ When encountering the error message `Failed to add ingredient`, ensure that the

<box type="warning">

When encountering the error message `Failed to add step`, ensure that the index(A whole number) has been keyed been in before keying in the step itself<br>
When encountering the error message `Failed to add step`, ensure that the index (A whole number) has been keyed been in before keying in the step itself<br>
Example: `1. Mix Water and Flour` **Note**: Ensure that a period and space is present after the index.
</box>

Expand All @@ -399,13 +401,13 @@ Example Used: `modify i/1 n/Flour q/100 u/g`

**Note**: Recipe being modified has 200g of flour as part of the ingredient list

<img src='images/ug-images/modifyExisting.png' width='650'>
<img src='images/ug-images/modifyExisting.png' width='650' height="480" class="center">


Example Used: `modify i/1 n/Cream q/100 u/g`
**Note**: Recipe being modified does not have cream in its ingredient list

<img src='images/ug-images/modifyNew.png' width='650'>
<img src='images/ug-images/modifyNew.png' width='650' height="480" class="center">

<box type="info">

Expand Down Expand Up @@ -454,12 +456,12 @@ Examples:
* `search flour` searches for all recipes that use `flour`
* `search butter` searches for all recipes that use `butter`

Example used: `search flour`: **Note**: Multiple recipes use the ingredient flour
Example used: `search flour` **Note**: Multiple recipes use the ingredient flour

<img src='images/ug-images/searchMultiple.png' width='650'>
<img src='images/ug-images/searchMultiple.png' width='650' height="480" class="center">


Example used: `search blueberry`: **Note**: Only one recipe uses the ingredient blueberry
Example used: `search blueberry` **Note**: Only one recipe uses the ingredient blueberry

<img src='images/ug-images/searchSingle.png' width='650'>

Expand All @@ -474,16 +476,18 @@ Format: `exit`

Inventory and Recipe data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

**Tip**: When the application loads for the first time and no command is run, no inventory or recipe data will be saved.
<box type="info">

**Note**: When the application loads for the first time and no command is run, no inventory or recipe data will be saved.
</box>
### Editing the data file

Inventory data are saved automatically as a JSON file `[JAR file location]/data/inventory.json`. Advanced users are welcome to update data directly by editing that data file.

<box type="warning" >

**Caution:**
If your changes to the data file makes its format invalid, Inventory 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.
If your changes to the data file makes its format invalid, all data will be discarded and you will start with an empty data file the next run. Hence, it is recommended to take a backup of the file before editing it.
</box>

--------------------------------------------------------------------------------------------------------------------
Expand All @@ -507,7 +511,7 @@ If your changes to the data file makes its format invalid, Inventory will discar
**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 [Ba]king [Br]ead home folder.

**Q**: The application does not run when I double-click it!<br>
**A**: First, check if you have Jave `11` installed in your computer. If you do and still have issues, try this: Open a command terminal, `cd` into the
**A**: First, check if you have Java `11` installed in your computer. If you do and still have issues, try this: Open a command terminal, `cd` into the
folder you put the jar file in, and use the `java -jar bakingbread.jar` command to run the application.<br>

--------------------------------------------------------------------------------------------------------------------
Expand Down

0 comments on commit 955c960

Please sign in to comment.