seedhammer-v1-companion/platform/v1/doc.go
mineracks 3696dd6b34 Initial skeleton — Phase 1 scaffolding
A browser-based companion for SeedHammer v1 hardware. Three coordinated
PWAs (composer, emulator, combined-sim) plus an optional Android wrapper,
inspired by Gangleri42's SeedHammer II fork but retargeted to v1's
Pi-Zero / WaveShare / MarkingWay hardware.

What's in this commit:

- LICENSE: Unlicense (matching upstream)
- README.md: project overview + status + roadmap
- CREDITS.md: upstream provenance + pinned baseline SHAs
- docs/architecture/: five authoritative design docs (lifted from
  the prep work in mineracks-infrastructure):
  * BASELINES.md — pinned SHAs, license audit, path-mapping table
  * v1-engrave-spec.md — MarkingWay USB-serial wire protocol audit
  * v1-buttons-and-ui.md — GPIO map, UI screen flow, keyboard map
  * sh1e-spec.md — composer-to-Pi envelope format spec
  * seedsigner-reuse.md — Pyodide strategy + jumbo (SeedSigner+) support
- Go package skeleton with doc.go contracts:
  backup, bezier, bspline, engrave, engrave/wire, engrave/wire/sh1e,
  font (+ comfortaa, poppins, constant), gui, input, internal/golden,
  platform/v1
- cmd/ entrypoints with stub main(): composer, emulator, combined-sim,
  seedsigner-sim
- web/ static-shell skeleton
- go.mod (module github.com/mineracks/seedhammer-v1-companion, Go 1.22)
- go build ./... + go vet ./... both clean

Next: lift universal packages (backup, font, bezier, bspline) from
upstream seedhammer/seedhammer at v1.3.0 verbatim.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-28 18:25:03 +10:00

22 lines
991 B
Go

// Package v1 holds platform adapters that bind gui/, input/, and engrave/
// to either a real SeedHammer v1 device or the browser emulator.
//
// Two build-time targets:
//
// - real: GOOS=linux GOARCH=arm — for the Pi Zero v1.3 itself.
// Binds gui/ frame output to driver/drm/, input/ to
// driver/wshat/ (GPIO via periph.io), engrave/ to
// driver/mjolnir/ (USB-serial to MarkingWay).
//
// - browser: GOOS=js GOARCH=wasm — for the in-browser emulator.
// Binds gui/ frame output to a JS-exposed canvas writer,
// input/ to keyboard events forwarded from the page,
// engrave/ to a null sink (preview) or animation harness
// (visual playback).
//
// Build constraints select the right adapter; both expose the same
// platform.Driver interface so gui/ doesn't know which it's running on.
//
// Status: STUB — interface design and both adapters land in Phase 1 + Phase 2.
package v1