https://github.com/kmein/mahlzeit

Kierán Meinhardt 954c0fb3f4 chore: merge 11 months ago
.github b33ffa4710 fix(ci): run cabal test after build 1 year ago
.todo d0d15bd9ea feat: add .todo dir 1 year ago
app 7dd4f90187 chore: reformat 11 months ago
examples 457f007bfc feat(recipes): add pasta elias 1 year ago
src 7dd4f90187 chore: reformat 11 months ago
test 9567d18614 fix(tests) 1 year ago
.gitignore 63230d00fe docs: improve readme 1 year ago
LICENSE 6c560ff969 feat(WIP): initial commit 1 year ago
README.md 63230d00fe docs: improve readme 1 year ago
Setup.hs 6c560ff969 feat(WIP): initial commit 1 year ago
default.nix 9567d18614 fix(tests) 1 year ago
mahlzeit.cabal ea4769ad69 feat: add tests 1 year ago

README.md

Mahlzeit!

Mahlzeit [ˈmaːlˌt͡saɪ̯t] helps you manage your favourite recipes.

Usage

To use Mahlzeit, you have to set the RECIPE_HOME variable in the environment where you run it.

$ export RECIPE_HOME=path/to/your/recipe/folder

Searching your Recipe Database

Mahlzeit allows you to search through your recipes by tags, ingredients and titles. The following, for example, looks for all vegan Asian meals that mention peanut butter in their ingredients.

$ mahlzeit list --ingredient "peanut butter" --tag asian --tag vegan
[satay-noodles] Vegan Satay Noodles *vegan, Asian*
[fried-rice] Easy Vegan Fried Rice *vegan, Asian*

Calculating the Right Amounts

Once you have found the perfect recipe for you, just provide Mahlzeit with number of servings you want. It will take care of the calculations.

$ mahlzeit show fried-rice 4
... RECIPE ...

Note: The output is valid Pandoc markdown, so you can easily pipe it into pandoc -o recipe.pdf to generate a good-looking PDF of your recipe.

Editing a Recipe

In case you want to edit a recipe, just run:

$ mahlzeit edit fried-rice

This should open your favourite editor (the EDITOR environment variable) with the recipe file you specified.

Importing from Meal-Master

Many recipes online still use a format that was first used by a DOS program called Meal-Master, or MM.EXE. Mahlzeit supports importing from this format. To import, run

$ mahlzeit import <path/to/your/recipe.mm>

If you find the parser having problems with a valid Meal-Master file, open an issue.

Mahlzeit's Recipe Format

For examples, see the examples directory.