Skip to content

Commit

Permalink
Merge pull request #249 from prawnzyy/branch-update-documentation
Browse files Browse the repository at this point in the history
Update
  • Loading branch information
ItsTYtan authored Nov 15, 2023
2 parents 676b0e9 + c372c5e commit 23db439
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Used to highlight errors to look out for
* [Add ingredient](#adding-an-ingredient-add)
* [Use ingredient](#using-up-ingredients-use)
* [Find quantity of ingredient](#finding-the-quantity-of-an-ingredient-by-name-stock)
* [Clear ingredient list](#clearing-all-entries-from-ingredient-stock-clear)
* [Clear ingredient list](#clearing-all-ingredients-from-ingredient-stock-clear)
* [View list of all recipes](#listing-all-recipes-list)
* [View a recipe](#viewing-specific-recipes-view)
* [Add a recipe](#adding-recipes-addrecipe)
Expand Down Expand Up @@ -128,8 +128,6 @@ into the application's input box as shown below.<br><br>
3. You should see the ingredient added into your ingredient list as seen below. Hooray! You have added your first ingredient!<br><br>
<img src='images/ug-images/quickstart_addingredient2.png' width='700'>

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

#### Adding your first recipe
Recipe adding is a little more complicated! But don't worry, you will get the hang of it in no time! Refer to the
infographic below for step-by-step instructions on adding your first recipe.
Expand Down Expand Up @@ -408,12 +406,15 @@ Example:
* Assuming flour is used in the recipe, `modify i/1 n/Flour q/100 u/g` modifies the `Flour` ingredient in the recipe to 100 grams of flour.
* Assuming flour is not used in the recipe, `modify i/1 n/Flour q/100 u/g` adds the 100 grams of the `Flour` ingredient to the recipe.

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

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'>

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

Example Used: `modify i/1 n/Cream q/100 u/g`
**Note**: Recipe being modified does not have cream in its ingredient list
Expand Down Expand Up @@ -467,10 +468,13 @@ Examples:
* `search flour` searches for all recipes that use `flour`
* `search butter` searches for all recipes that use `butter`

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

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

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

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

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

Expand All @@ -490,6 +494,7 @@ Inventory and Recipe data are saved in the hard disk automatically after any com

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

### 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.
Expand Down

0 comments on commit 23db439

Please sign in to comment.