Skip to content

Commit

Permalink
Merge pull request #239 from prawnzyy/branch-update-documentation
Browse files Browse the repository at this point in the history
Branch update documentation
  • Loading branch information
dhruvir29 authored Nov 15, 2023
2 parents 92ec131 + 351c7ca commit 956dee0
Showing 1 changed file with 11 additions and 24 deletions.
35 changes: 11 additions & 24 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ If you can type fast, [Ba]king [Br]ead can get your ingredient and recipe manage
<div style="page-break-after: always;"></div>

## Using this Guide
This user guide contains all the information you will need in order to use [Ba]king [Br]ead.
This user guide contains all the information you will need in order to use [Ba]king [Br]ead. For new users, this document will also guide you in using the application,
starting with the more essential features.

**For new users**:
- Start using [Ba]king [Br]ead by heading over to the [Quick Start](#quick-start) to learn how to set up the app and use it.
Expand Down Expand Up @@ -75,12 +76,12 @@ Used to highlight errors to look out for
## Glossary
Listed below are the definitions of the terminology used throughout the User Guide

| Term | Definition |
|:-------------------------------------|:-------------------------------------------------------------------|
| GUI (Graphical User Interface) | The visual interface of [Ba]king [Br]ead |
| Command | A set of words that execute a certain operation |
| Parameter | Specific information that a command needs for it to be run |
| UUID (Universally Unique IDentifier) | An integer that is used to identify the recipes |
| Term | Definition |
|:-------------------------------------|:--------------------------------------------------------------|
| GUI (Graphical User Interface) | The visual interface of [Ba]king [Br]ead |
| Command | A set of words that execute a certain operation |
| Parameter | Specific input information that a command needs for it to run |
| UUID (Universally Unique IDentifier) | An integer that is used to identify the recipes |


## Quick start
Expand Down Expand Up @@ -215,13 +216,6 @@ Example Used: `add n/Milk q/600 u/g` **Note**: Sample data does not contain Milk

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

Supported Units:
| Unit | Alias |
|----------|---------------------------------------|
| GRAM | g, gram, GRAM |
| KILOGRAM | kg, kilogram, KILOGRAM |
| PIECE | pc, pcs, piece, pieces, PIECE, PIECES |

### Using up ingredients : `use`

Depletes a specified amount of an ingredient from the stock.
Expand Down Expand Up @@ -250,16 +244,9 @@ Example Used: `use n/Milk q/600 u/g` **Note**: Data shown started with 1kg of Mi

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

Supported Units:
| Unit | Alias |
|----------|---------------------------------------|
| GRAM | g, gram, GRAM |
| KILOGRAM | kg, kilogram, KILOGRAM |
| PIECE | pc, pcs, piece, pieces, PIECE, PIECES |

<box type="warning">

When encountering the error message `Ingredient does not exist in Inventory`, either add it in first or use a different ingredient
**Caution**: When encountering the error message `Ingredient does not exist in Inventory`, either add it in first or use a different ingredient
</box>

### Finding the quantity of an ingredient by name: `stock`
Expand Down Expand Up @@ -367,12 +354,12 @@ complete recipe

<box type="warning">

When encountering the error message `Failed to add ingredient`, ensure that the ingredient keyed in follows the following format **exactly** : `(NAME) (QUANTITY)(UNIT)` Example: `Milk 100g`
**Caution**: When encountering the error message `Failed to add ingredient`, ensure that the ingredient keyed in follows the following format **exactly** : `(NAME) (QUANTITY)(UNIT)` Example: `Milk 100g`
</box>

<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>
**Caution**: 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 Down

0 comments on commit 956dee0

Please sign in to comment.