From 321df6badc6c8eeb47f49dafc4ff5920fbdd3c1d Mon Sep 17 00:00:00 2001 From: James Brechtel Date: Mon, 18 May 2026 21:44:55 -0400 Subject: [PATCH] Elaborates more of the project description --- README.org | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 8a32326..79131d2 100644 --- a/README.org +++ b/README.org @@ -13,11 +13,18 @@ Roux uses Cooklang (https://cooklang.org/) as a source of truth for all recipe c *** Cook history Roux lets you track when you cook recipes. I like this because we cook a lot of different recipes and I like to be able to go back to find things I liked in the past so I don't forget about them. -** Tech stack +** Technical details +*** Development environment +Docker is used for all development tools. Nothing is required to be installed on the local machine except Docker. *** Backend API: Haskell + SQLite *** Frontend: Static HTML + Pico CSS The actual backing for recipes themselves is a single cooklang directory with an in-process search index that gets rebuilt whenever a file is added to the directory. +*** Project structure: +**** cooklang-hs +A Cooklang parser written in Haskell. +**** roux-server +The webserver for Roux. Parses Cooklang files on disk, indexes them, renders HTML templates for presenting recipes.