Skip to content

Add curl installer and visual product README - #1

Merged
jakthom merged 2 commits into
mainfrom
docs/readme-installation
Jul 25, 2026
Merged

Add curl installer and visual product README#1
jakthom merged 2 commits into
mainfrom
docs/readme-installation

Conversation

@jakthom

@jakthom jakthom commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • lead with the problem n2k solves and a complete debugging-workflow overview
  • add a copy-paste curl installer with SHA-256 verification
  • support macOS, Linux, and Windows across amd64 and arm64 release assets
  • document Homebrew, go install, release archive, and source-build paths
  • add TUI and scriptable CLI screenshots
  • add a hardware-free quick start using the bundled sample capture
  • exercise the release installer in the Linux, macOS, and Windows CI matrix

Verification

  • installed the published release through the pushed curl pipeline
  • verified all six release archive names
  • validated both SVG assets
  • ran the sample-capture command and Go tests
  • checked shell syntax and README whitespace

@jakthom jakthom changed the title Improve installation and quick-start documentation Add curl installer and visual product README Jul 25, 2026
@jakthom
jakthom merged commit 3227cfa into main Jul 25, 2026
7 checks passed
@jakthom
jakthom deleted the docs/readme-installation branch July 25, 2026 15:56
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