herms-1.8.1.2: README.md
# Herm's
HeRM's: a Haskell-based Recipe Manager (yes, food recipes) for the command line.
### Features
- Add recipes! :)
- Look at recipes! :D
- Edit recipes! :DD
- Serving size adjustment! :DDD
- Remove recipes :(
- View metric recipes in imperial units and vice-versa
- Import recipe files
- Generate shopping lists
- Keep track of recipes with tags
### Installation
Via Hackage:
```
cabal update
cabal install herms
```
Manually cloning and installing from source:
```
git clone https://github.com/JackKiefer/herms
cd herms
cabal update
cabal install -j
```
### Usage
```
Usage:
herms list [-g|--group] [--tags TAGS] list recipes
[--name-only ]
herms add add a new recipe (interactively)
herms edit RECIPE_NAME edit a recipe
herms import FILE_NAME import a recipe file
herms remove RECIPE_NAMES remove the particular recipes
herms view RECIPE_NAMES [-s|--serving INT] view the particular recipes
[-t|--step]
[-c|--convert CONV_UNIT]
herms shopping RECIPE_NAMES [-s|--serving INT] generate shopping list for particular recipes
Available options:
-h|--help Show this help text
RECIPE_NAME index or Recipe name
--sort SORT_ORDER 'tags' to sort by tags
-s|--serving INT specify serving size when viewing.
E.g., 'herms view -s 2 {recipe}' for two servings
-t|--step View recipe in "one-step-at-a-time" mode
(press enter between each direction)
-g|--group group recipes by tags
--tags TAGS show recipes with particular flags
--name-only only list recipes by name
-c|--convert CONV_UNIT view the recipe converted to imperial or metric
E.g., 'herms view 2 -c imperial'
```
In honor of Logan, Utah's greatest Breakfast & Brunch.
