Skip to content

Docs: bring everything in line with the scanner catalog - #6

Merged
sepgh merged 5 commits into
mainfrom
docs-refresh
Oct 28, 2026
Merged

sepgh merged 5 commits into
mainfrom
docs-refresh

Conversation

@sepgh

@sepgh sepgh commented Oct 28, 2026

Copy link
Copy Markdown
Owner

Reviewed every document and the source header comments against the current code (0.2.0).

  • README: install/run/udev described generically (catalog, --scanner), diagram shows Unix socket or loopback TCP and the catalog, paths table adds scanners.txt, try/ and the driver cache, checksum troubleshooting points at models/, roadmap lists what shipped in 0.1/0.2, links both design notes; dropped the stale "status: v1" badge.
  • how-it-works: catalog section in the contents, components table and decisions generalised beyond the V600, "scanners as data" decision, how a model selects the firmware protocol.
  • development: transport is Unix socket or TCP, helper example uses the required --device, catalog inspection commands, release checklist includes CHANGELOG and README links.
  • Plan / specs: status lines reflect what shipped; v1 spec notes which parts moved into the catalog.
  • Comments: transport.h and usbd.c mention the TCP fallback.

All relative links checked; make test-report passes.

🤖 Generated with Claude Code

sepgh and others added 5 commits October 28, 2026 20:01
README: generic install/run/udev wording, diagram with the transport choice
and the catalog, paths for scanners.txt, try sessions and driver cache,
checksum troubleshooting pointing at models/, roadmap and design-note
links. how-it-works: catalog in the contents and components, 'scanners as
data' decision, firmware protocol selection. development.md: transport
description, helper example with --device, catalog commands, release
checklist. Plan and spec status lines updated; source comments mention the
TCP fallback.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Show docs/silverfast-linux.png at the top of the README and credit Tux's
author, as Larry Ewing asks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The tagline, badge and 'What works' table no longer imply a V600-only
tool: scanners come from the catalog, and the Epson Perfection V600 is
named as the reference scanner used for development and testing, which
works end to end. how-it-works and adding-a-scanner use the V600 as the
example and mark per-scanner values (USB IDs, interpreter, firmware,
packet size) as such.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
It reused LaserSoft's trademarked eye logo; a disclaimer does not make
that use safe, so the README goes back to a text header.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sepgh
sepgh merged commit 19810d6 into main Oct 28, 2026
2 checks passed
@sepgh
sepgh deleted the docs-refresh branch October 28, 2026 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant