Repository navigation

docs: rebuild the README around the demo, with quick start, data and limits - #134

Merged

ShreySuri merged 17 commits into

mainfrom

shrey/readme

Sep 27, 2026

Merged

docs: rebuild the README around the demo, with quick start, data and limits#134
ShreySuri merged 17 commits into
mainfrom
shrey/readme

Commits on Sep 27, 2026
- docs: rebuild the README around the demo, with quick start, data and limits
  
  Shrey Suri
  and
  claude
  committed
  55286df
- docs: draw the README architecture as a vertical flow that matches the code
  
  Shrey Suri
  and
  claude
  committed
  1d0c49d
- docs: color the architecture diagram, make the pipeline static, and play the unseen demo at 60 fps
  
  Shrey Suri
  and
  claude
  committed
  f86a298
- docs: size the diagram's labels the way GitHub draws them
  
  Shrey Suri
  and
  claude
  committed
  9ccb79e
- docs: add the rules, a real request and answer, and the measurements to the README
  
  Shrey Suri
  and
  claude
  committed
  eed8c1a
- docs: name every diagram step as a verb, in the order the homeowner lives it
  
  Shrey Suri
  and
  claude
  committed
  9ad1a81
- docs: list all four teammates in the README, with roles and GitHub contacts
  
  Shrey Suri
  and
  claude
  committed
  8a78c82
- docs: rewrite the README's headings and prose for a first-time reader
  
  Shrey Suri
  and
  claude
  committed
  05d239d
- docs: redraw the architecture as draw.io swimlanes with static arrows
  
  Shrey Suri
  and
  claude
  committed
  f843fd7
- Update README for clarity on battery placement process
  ShreySuri
  authored
  b0c5829
- docs: fix typos and the check-versus-answer wording from the README web edit
  
  Shrey Suri
  and
  claude
  committed
  c0332f6
- docs: add a rebuild animation and a gas-meter margin figure to the README
  
  Shrey Suri
  and
  claude
  committed
  bcb6abd
- docs: point the rebuild animation's intro at the deterministic evaluation
  
  Shrey Suri
  and
  claude
  committed
  2bd6a2a
- Remove commented lines from README.md
  ShreySuri
  authored
  9ceeece
- docs: add the Modal infrastructure diagram to the README
  Shrey Suri
  committed
  c139ccd
- Merge branch 'shrey/readme' of https://github.com/SamGu-NRX/house-scanning into shrey/readme
  Shrey Suri
  committed
  b4a7edc
- Merge main into shrey/readme
  
  AidenJohnston
  and
  claude
  committed
  5dfc375

Commits

Commits on Sep 27, 2026