Skip to content

sciguy16/recipes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

recipes

A collection of delicious recipes

Main repository is hosted at https://git.dyoung.tech/sciguy16/recipes but as long as the auto-deploy hooks work properly then https://github.com/sciguy16/recipes should always be up to date.

Structure of this repository

Each recipe is broadly classified into either main or dessert, and then in an appropriately named directory. The recipe directory contains three files:

  • title.txt the title for the recipe
  • description.txt a text file containing a description of the recipe, e.g. number of people served. Acts as a bit of a README
  • ingredients.txt list of ingredients
  • method.txt one step per line, list of instructions

How to use/build

Your system must have access to pdflatex, GNU Make (other makes probably work too), and the mighty ed text editor. There are two supported use cases: building all of the recipe PDFs in one go, or building them individually.

Build all at once

  • Run make in the the root directory of this repo to build all of the recipes
    • For blazing-fast build times try running make multithreaded!
  • make clean will delete all of the temporary files that were generated by make, but leave the recipe PDFs and the per-recipe Makefiles
  • Running make allclean will delete everything that make made and resets everything back to how it was before the call to make.

Build an individual recipe

  • Run make makefiles in the root directory to populate the recipe directories with symlinks to the recipe makefile
  • Navigate to the directory containing the recipe that you want to build and run make
  • make clean will delete the temporary files but not the recipe.pdf, and make allclean will delete everything that make made

Adding a new recipe

To take the manual effort out of running mkdir and remembering the filenames, instead run ./newrecipe.sh mains/pie from the root directory. The argument "mains/pie" is the category of food and the name of the food. Then simply edit the created txt files and run the above build process.

About

A collection of delicious recipes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published