Skip to content

Commit

Permalink
Merge pull request #240 from ItsTYtan/branch-ug-update
Browse files Browse the repository at this point in the history
Branch ug update
  • Loading branch information
prawnzyy committed Nov 15, 2023
2 parents 956dee0 + c98b436 commit db14402
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,18 @@ pageNav: 3
---

# [Ba]king [Br]ead User Guide
Welcome! If you are a new baker suffering under the mess and stress of baking, [Ba]king [Br]ead is here to help organise
your kitchen and recipes.

[Ba]king [Br]ead is a **desktop app for managing recipes and ingredient inventory, optimized for use via a
Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). [Ba]king [Br]ead is targeted
towards bakers like yourselves to aid you on your baking journey.
[Ba]king [Br]ead will help you to:
1. Keep track of all your baking ingredients in your kitchen
2. Collate all your recipes digitally for easy viewing
3. Do all the above with blazing efficiency, your fast fingers and our application's command line interface makes this
uniquely possible.

Tired of rummaging through your cupboard to check what ingredients and how much of it you have? Fret not, with [Ba]king [Br]ead, you will be able to manage your stock with ease so the next time you want
to bake something or go grocery shopping, you know exactly what you have! And if you are tired of having to flip through physical
recipe books to find a recipe you want, once again [Ba]king [Br]ead has you covered! With [Ba]king [Br]ead you will be able to
view your recipes with ease, making it much easier to manage your recipes!

If you can type fast, [Ba]king [Br]ead can get your ingredient and recipe management tasks done faster than traditional GUI apps.
You will never forget what Ingredient you need to stock up on during your next trip to the supermarket. You will never
have to flip through heavy physical recipe books any longer. What are you waiting for? Master [Ba]king [Br]ead and
fast-track your baking journey now!

--------------------------------------------------------------------------------------------------------------------
## Table of Contents
Expand Down Expand Up @@ -99,7 +100,7 @@ New to [Ba]king [Br]ead? Not to worry, simply follow the instructions below to g

### 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)
![Ui](images/Ui-annotated.png)<br>
**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 inputted.<br>
**Ingredients list:** Contain a list view of all your ingredients with their specified quantity and unit.<br>
Expand All @@ -110,11 +111,11 @@ The GUI may be confusing if you are a first time user of our application. Here i
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>
into the application's input box as shown below.<br><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'>
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='860'>

#### 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
Expand Down
Binary file modified docs/images/Ui-annotated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ug-images/quickstart_addingredient2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit db14402

Please sign in to comment.