Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Branch ug update #234

Merged
merged 3 commits into from
Nov 15, 2023
Merged

Branch ug update #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2165fd
Reorganise quickstart part 1
ItsTYtan Nov 15, 2023
c32390f
Merge branch 'master' into branch-ug-update
ItsTYtan Nov 15, 2023
e220866
Fix quickstart
ItsTYtan Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 38 additions & 29 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,36 +53,48 @@ Listed below are the definitions of the terminology used throughout the User Gui


## Quick start

New to [Ba]king [Br]ead? Not to worry, simply follow the instructions below to get started!

### Setting up [Ba]king [Br]ead
1. Ensure you have Java `11` or above installed in your Computer.

2. Download the latest `bakingbread.jar` from [here](https://github.com/AY2324S1-CS2103T-F10-3/tp/releases).

3. Copy the file to the folder you want to use as the _home folder_ for [Ba]king [Br]ead.

4. 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>
A GUI similar to the one below should appear in a few seconds. Note how the app contains some sample data. For more
information on how to navigate the GUI, head over to this [section](#navigating-the-gui). <br>
<img src='images/Ui.png' width='650'>

5. Type the command in the input box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
Some example commands you can try:

* add n/Flour q/10 u/kg (Add Command)
* use n/Flour q/5 u/kg (Use Command)
* stock Flour (Stock Command)

6. Refer to the [Features](#features) below for details of each command.
A GUI similar to the one below should appear in a few seconds. Note how the app contains some sample data.

## Navigating the GUI
### Navigating the GUI
The GUI may be confusing if you are a first time user of our application. Here is the breakdown of the GUI for [Ba]king [Br]ead.
![Ui](images/Ui-annotated.png)
**Input box:** This is where you will be inputting your commands.<br>
**Command result box:** Where the application will return a message regarding the outcome of command you inputted.<br>
**Command result box:** Where the application will return a message regarding the outcome of command inputted.<br>
**Ingredients list:** Contain a list view of all your ingredients with their specified quantity and unit.<br>
**Recipe list:** Contains a list view of all your recipes.<br>

### Tutorial
#### Adding your first ingredient
Time to add your first ingredient! Take any ingredient from your kitchen, weigh the quantity of that ingredient and
let's get started!
1. Suppose you decided flour would be your first ingredient, and that you have 100 grams of flour. Type in the command
into the application's input box as shown below.<br>
<img src='images/ug-images/quickstart_addingredient1.png' width='650'> <br><br>
2. Press enter to execute the command
3. You should see the ingredient added into your ingredient list as seen below. Hooray! You have added your first ingredient!<br>
<img src='images/ug-images/quickstart_addingredient2.png' width='650'>

#### Adding your first recipe
Recipe adding is a little more complicated! But do not 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.

![Addrecipe Instructions](images/ug-images/addrecipe_instructions1.png)
![Addrecipe Instructions](images/ug-images/addrecipe_instructions2.png)

<box type="tip">If you are stuck at any point, typing **`help`** and pressing Enter will open the help window to guide you along.</box>

<box type="tip">Refer to the [Features](#features) below for details of the other commands available!</box>

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

Expand Down Expand Up @@ -132,7 +144,7 @@ Supported Units:

If you are not sure how to use [Ba]king [Br]ead, this command will show a pop-up with a link to access the help page.

<img src='images/helpMessage.png' width='650' align="center">
<img src='images/helpMessage.png' width='650'>

Format: `help`

Expand All @@ -159,7 +171,7 @@ Examples:

Example Used: `add n/Flour q/1 u/kg` **Note**: Sample data starts off with 3kg of Flour.

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

Example Used: `add n/Milk q/600 u/g` **Note**: Sample data does not contain Milk.

Expand Down Expand Up @@ -198,7 +210,7 @@ Examples:

Example Used: `use n/Milk q/600 u/g` **Note**: Data shown started with 1kg of Milk.

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

Supported Units:
| Unit | Alias |
Expand Down Expand Up @@ -227,7 +239,7 @@ Examples:

Example used: `stock butter`

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

### Clearing all entries from ingredient stock : `clear`

Expand All @@ -237,7 +249,7 @@ Format: `clear`

Example used: `clear`

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

### Listing all Recipes : `list`

Expand All @@ -247,7 +259,7 @@ Format: `list`

Example Used: `list`

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

Examples:
* `list` lists out all recipes within [Ba]king [Br]ead.
Expand All @@ -266,7 +278,7 @@ Examples:

Example Used: `view 1`

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

### Adding Recipes : `addrecipe`

Expand Down Expand Up @@ -311,9 +323,6 @@ complete recipe
**Caution:** As this function relies heavily on the user's input, please do check that your input is of the correct format.
</box>

![Addrecipe Instructions](images/ug-images/addrecipe_instructions1.png)
![Addrecipe Instructions](images/ug-images/addrecipe_instructions2.png)

### Modifying Recipes : `modify`

Modifies the ingredients in a recipe.
Expand All @@ -332,11 +341,11 @@ Example:

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' align="center">
<img src='images/ug-images/modifyExisting.png' width='650'>

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' align="center">
<img src='images/ug-images/modifyNew.png' width='650'>

### Deleting Recipes : `delete`

Expand Down Expand Up @@ -368,12 +377,12 @@ Examples:

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

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


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

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

### Exiting the program : `exit`

Expand Down
Binary file added docs/images/ug-images/quickstart_addingredient1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ug-images/quickstart_addingredient2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.