From 57e3172e749b3ed16a6cf812d104bdcc9c99fd85 Mon Sep 17 00:00:00 2001 From: Ryan Chou Date: Sun, 22 Mar 2026 19:22:52 -0700 Subject: [PATCH] add: readme --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index e69de29..f3d40a6 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,40 @@ +# Gallery + +Static photo gallery for logging meals and food memories. + +The site is based on the HTML5 UP Lens template and currently ships as a plain static site: HTML, CSS, JavaScript, and local image assets. + +## Repo Layout + +- `index.html`: main gallery page +- `assets/`: site CSS, JavaScript, fonts, and audio +- `images/fulls/`: full-size gallery images +- `images/thumbs/`: gallery thumbnails +- `data/meals.json`: source of truth for gallery entries +- `scripts/render-gallery.js`: regenerates the gallery markup in `index.html` from `data/meals.json` + +## Content Workflow + +Gallery entries now live in `data/meals.json`. + +After editing that file, regenerate the static markup with: + +```sh +node scripts/render-gallery.js +``` + +The script updates only the generated gallery block inside `index.html`. + +## Image Conventions + +- Full-size images and thumbnails share the same numeric ID +- Full-size images live at `images/fulls/.jpg` +- Thumbnails live at `images/thumbs/.jpg` +- Optional thumbnail focal positioning is stored per entry as `position` + +## Planned Features + +1. Better thumbnail implementation, either a small script to automatically convert full-size images into thumbnails and a build system, or another simpler approach. +2. Automatic image ingestion, potentially with a stronger data model if the static workflow becomes too limiting. +3. An Elo-style ranking page that shows two food images at a time and updates rankings automatically based on the selected winner. +4. General cleanup and history cleanup once the bigger structural changes are in place.