gamerdonkey/recipes_for_engineers
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme for renames

Browse Source
This commit is contained in:
gamerdonkey 2025-09-11 05:19:49 +00:00
parent 7ce5a2bb8b
commit 163f5cacab
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -4,7 +4,11 @@ Store recipes in a nerdy JSON tree format and use that to generate [Cooking for
Right now this project is just a set of scripts.
## `make_tree.py`
## Requirements
These scripts require the `anytree` Python library.
## `create_recipe_json.py`
This is a fairly naive script that walks you through the process of turning a recipe into a tree structure. It has you list out ingredients, and then add tasks to perform on those ingredients. You end up with a tree that is something like this:
@ -26,10 +30,10 @@ shake and grill for 20 more mins
Leaves are raw ingredients, other nodes are tasks. The tree is output to a JSON file.
## `output_html.py`
## `recipe_json_to_html.py`
This script takes that JSON file and does a recursive depth-first search to render an HTML-table-based recipe card.
This script takes that JSON file and does a recursive depth-first search to render a webpage with an HTML-table-based recipe card.
## Known Issues
- A single node cannot have multiple done on it. So this cannot represent, for example, mixing brown sugar and cinnamon, then splitting that mixture up and doing separate subsequent operations with the two batches.
- A single node cannot have multiple tasks done on it (nerdy reason: because a node cannot have two parents). So this cannot represent, for example, mixing cinnamon and sugar, then splitting that mixture up and doing separate subsequent operations with the two batches.