- recipes.csv: Specify name, ingredients, preparation steps. Sample.
- Instructions not supported. This program only does a few things and does them well---help you plan ahead (shopping and completing preparation steps). It is not a recipe book.
- agenda.md: Specify the week's meals in a markdown table. Sample.
- stock.csv (optional): Specify the stock of ingredients in your home. Sample.
- Recommended to only have durable goods recorded, e.g. spices, sauces, etc.
- For other ingredients, produce a meal planner first and check the ingredients you have on the fly. Your changes will be saved in the next meal planner, when you feed the program with the modified agenda.
It is also recommended to have the following installed:
- Any Markdown Viewer
- Any CSV Editor
- Clone this repository
- Run
make
in the root directory: This will take the pre-existing sampleagenda.md
,recipes.csv
, andstock.csv
to generate the meal planner in theout
directory.
By modifying the sample files: agenda.md
, recipes.csv
, and stock.csv
. Be sure to adhere to the syntax and format of the sample files strictly. The parser is not designed to handle any deviations from the sample files.
- Be aware of whitespace, line breaks, and delimiters (
,
,|
,:
,;
). - Use ISO-8601 duration format
PnDTnHnMn.nS
to specify durations (how much time ahead) for preparation steps.