Skip to content

Commit 0969bb1

Browse files
MrMatt57claude
andauthored
Add device and web UI screenshots to README (#25)
## Summary - Split README hero area into two sections: **Touchscreen Dashboard** and **Web Interface** - Added device touchscreen screenshot (`pitclaw-device.png`) - Updated web UI screenshot (`pitclaw.png`) - Each section has a heading and short description for a cleaner, more professional layout ## Test plan - [x] README renders correctly on GitHub with both image references - [x] Placeholder filename `pitclaw-device.png` is referenced correctly - [x] Existing `pitclaw.png` reference is preserved Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent baf9ce4 commit 0969bb1

4 files changed

Lines changed: 45 additions & 1 deletion

File tree

.specs/017-readme-screenshots.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# 017: Update README Screenshots
2+
3+
**Branch**: `feature/readme-screenshots`
4+
**Created**: 2026-02-18
5+
6+
## Summary
7+
8+
Update the README to showcase both the hardware device and the web UI. Add a second screenshot for the embedded touchscreen device and update the existing web UI screenshot reference.
9+
10+
## Requirements
11+
12+
- Add a hardware/device screenshot placeholder in `docs/media/` (filename: `pitclaw-device.png`)
13+
- Keep the existing web UI screenshot (`docs/media/pitclaw.png`) — user will replace the file with an updated version
14+
- Update `README.md` to display both screenshots prominently near the top
15+
16+
## Design
17+
18+
Update the hero section of the README (after the badges, before Features) to show two screenshots side by side or stacked:
19+
1. Hardware device photo (`pitclaw-device.png`) — placeholder file for now
20+
2. Web UI screenshot (`pitclaw.png`) — existing file, user will update the actual image
21+
22+
Use a simple markdown table or inline images to display both.
23+
24+
## Files to Modify
25+
26+
| File | Change |
27+
|------|--------|
28+
| `README.md` | Update screenshot section to show both device and web UI images |
29+
30+
## Test Plan
31+
32+
- [x] README renders correctly on GitHub with both image references
33+
- [x] Placeholder filename `pitclaw-device.png` is referenced correctly
34+
- [x] Existing `pitclaw.png` reference is preserved

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@
44

55
Open-source BBQ temperature monitor and controller. Uses an ESP32-S3 with a 3.5" touchscreen to maintain precise smoker temperature via PID-controlled fan and optional servo damper. Reads Thermoworks-compatible thermistor probes. Includes a web interface (PWA) for remote monitoring from any phone or computer on Wi-Fi. Touchscreen works fully offline.
66

7-
![Pit Claw Web UI](docs/media/pitclaw.png)
7+
### Touchscreen Dashboard
8+
9+
Real-time temperature display on the 3.5" capacitive touchscreen. Works fully offline — no Wi-Fi required.
10+
11+
![Pit Claw touchscreen dashboard](docs/media/pitclaw-device.png)
12+
13+
### Web Interface
14+
15+
Browser-based PWA with live temperature graph, predictive done-time curves, and full cook session control. Access from any device at `http://bbq.local`.
16+
17+
![Pit Claw web UI with temperature history graph](docs/media/pitclaw.png)
818

919
## Features
1020

docs/media/pitclaw-device.png

49.6 KB
Loading

docs/media/pitclaw.png

1.28 KB
Loading

0 commit comments

Comments
 (0)