README improvements

This commit is contained in:
gamerdonkey 2025-09-19 02:48:34 +00:00
parent 6c18cb8dbe
commit e8124964c6

View File

@ -6,8 +6,8 @@ HTML.
I used these scripts to create my [recipes I used these scripts to create my [recipes
site](https://tilde.town/~gamerdonkey/recipes/) here on town. Fun fact: you can site](https://tilde.town/~gamerdonkey/recipes/) here on town. Fun fact: you can
replace the `html` with `json` in the URLs to get my recipes in their raw JSON replace the `html` in the URLs with `json` to get my recipes in their raw JSON
format. format!
## Requirements ## Requirements
@ -54,8 +54,8 @@ JSON YOU DID NOT CREATE YOURSELF!**
This script takes an argument pointing to a directory of recipe JSON files, in This script takes an argument pointing to a directory of recipe JSON files, in
the format created by the `create_recipe_json.py` script. It then does a the format created by the `create_recipe_json.py` script. It then does a
recursive depth-first search on each tree in that file to generate an HTML recursive depth-first search on each tree in each file to generate HTML files
file with a traditional recipe and a tabular-style recipe card. It also takes with a traditional recipe and a tabular-style recipe card. You may also pass
an optional argument pointing to a file and, if given, the contents of that an optional argument pointing to a file and, if given, the contents of that
file will be inserted into the header section of the generated `index.html`. file will be inserted into the header section of the generated `index.html`.