alicia-lyu / MealPlanner

A Java-based meal 🥘 planner generator that helps you plan ahead! God I love to write nice OOP code!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Meal Planner Generator

Build a meal planner (.md) from

  • 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.

Sample output meal planner.

Minimal dependencies

It is also recommended to have the following installed:

Get started

  • Clone this repository
  • Run make in the root directory: This will take the pre-existing sample agenda.md, recipes.csv, and stock.csv to generate the meal planner in the out directory.

Build your own meal planner

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.

About

A Java-based meal 🥘 planner generator that helps you plan ahead! God I love to write nice OOP code!

License:MIT License


Languages

Language:Java 92.4%Language:Makefile 7.6%