Skip to content

Commit

Permalink
Merge pull request #186 from oliviajohansen/UG1.3
Browse files Browse the repository at this point in the history
Final UG Update
  • Loading branch information
oliviajohansen authored Oct 27, 2020
2 parents c1b2864 + 61a9324 commit e508642
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: User Guide

Choose a topic from the table of contents to get started on your **Wishful Shrinking journey**.

##Table of Contents
## Table of Contents

1. [Overview](#1-overview)
- [1.1. Introduction](#11-introduction)
Expand All @@ -27,20 +27,23 @@ Choose a topic from the table of contents to get started on your **Wishful Shrin
* [5.1.7 Closing the recipe drawer : `close`](#close-recipe)
* [5.1.8 Searching for a recipe: `searchR`](#search-recipe)
* [5.1.9 Recommending recipes : `recommend`](#recommend-recipe)
* [5.1.10 Clearing all recipes : `clearR`](#clear-recipe)
* [5.1.10 Clearing all recipes : `clearR`](#clear-recipe)
<br>
- [5.2 Fridge-related Commands](#52-ingredient-related-commands)
* [5.2.1 Adding an ingredient: `addF`](#add-ingredient)
* [5.2.2 Listing all ingredients : `fridge`](#list-ingredient)
* [5.2.3 Deleting an ingredient : `deleteF`](#delete-ingredient)
* [5.2.4 Editing an ingredient: `editF`](#edit-ingredient)
* [5.2.5 Getting an ingredient to edit: `editF`](#get-edit-ingredient)
* [5.2.6 Searching for an Ingredient: `searchF`](#search-ingredient)
* [5.2.7 Clearing all ingredients : `clearF`](#clear-ingredient)
* [5.2.7 Clearing all ingredients : `clearF`](#clear-ingredient)
<br>
- [5.3 Consumption-related Commands](#53-consumption-related-commands)
* [5.3.1 Eating a recipe : `eatR`](#eat-consumption)
* [5.3.2 Listing all recipes eaten : `calories`](#list-consumption)
* [5.3.3 Deleting a recipe eaten: `deleteC`](#delete-consumption)
* [5.3.4 Clearing all consumed recipes : `clearC`](#clear-consumption)
* [5.3.4 Clearing all consumed recipes : `clearC`](#clear-consumption)
<br>
- [5.4 Miscellaneous Commands](#54-miscellaneous-commands)
* [5.4.1 Viewing help : `help`](#help)
* [5.4.2 Exiting the program : `exit`](#exit)
Expand All @@ -50,7 +53,7 @@ Choose a topic from the table of contents to get started on your **Wishful Shrin
8. [Command Summary](#8-command-summary)




# 1. Overview <a id="1-overview"></a>
Welcome to the Wishful Shrinking User Guide! In this section, you will be given an overview of what Wishful
Expand Down Expand Up @@ -78,21 +81,21 @@ This section will explain the symbols in the user guide, and the format and para

## 2.1 Symbols <a id="21-symbols"></a>
Symbol | Meaning
--------|------------------
:memo | This symbol indicates information to take note of.
:bulb | This symbol indicates a helpful tip when using the command.
-------|------------------
:memo: | This symbol indicates information to take note of.
:bulb: | This symbol indicates a helpful tip when using the command.

## 2.2 Parameters <a id="22-parameters"></a>

Prefix | Parameter | Meaning
--------|----------|--------
[]()| INDEX | Index of item in the displayed item list
n/ | NAME | Name of recipe or name of ingredient
i/ | INGREDIENT | Ingredient name and optional quantity
instr/ | INSTRUCTION | Instructions of a recipe
c/ | CALORIE | Calories of a recipe
img/ IMAGE | Image address of a recipe
img/ | IMAGE | Image address of a recipe
t/ | TAG | Recipe tag
[]()| INDEX | Index of item in the displayed item list

## 2.3 Format <a id="23-format"></a>

Expand Down

0 comments on commit e508642

Please sign in to comment.