Skip to content

README.md

Latest commit

 

History

History
67 lines (49 loc) · 1.71 KB

README.md

File metadata and controls

67 lines (49 loc) · 1.71 KB

SnapPin

SnapPin is a free and open-source Windows screenshot, annotation, and pin utility built for fast keyboard/mouse workflows.

Features

  • Static capture with frozen-frame visual pause
  • Dimmed mask with selection highlight
  • Auto window hover selection and drag region selection
  • Post-capture toolbar actions: Copy, Save, Pin, Mark, OCR (placeholder), Close
  • Annotation editor baseline: Rect, Line, Arrow, Pencil, Text, Undo/Redo, range reselect
  • Multi-pin image windows with close/destroy lifecycle actions
  • Tray-resident single-instance app

Detailed progress and parity tracking: docs/Implementation-Status.md.

Build

Requirements:

  • Windows 10/11
  • Visual Studio 2022 Build Tools (MSVC v143)
  • CMake 3.24+
  • Ninja

Configure:

cmake -S . -B "build/MSVC v143 x64 (vcvars64 + Ninja)-Release" -G Ninja -DCMAKE_BUILD_TYPE=Release

Build:

cmake --build "build/MSVC v143 x64 (vcvars64 + Ninja)-Release" --config Release --target all --

Run:

.\build\MSVC v143 x64 (vcvars64 + Ninja)-Release\bin\snappin.exe

Project layout

src/
  app/       app wiring, actions, tray, runtime services
  ui/        overlay, toolbar, settings, annotate, pin windows
  capture/   capture backends and service interface
  export/    clipboard and file export
  core/      shared types and contracts
tests/
docs/

Specs and Design

  • Active spec index: docs/specs/00_overview.md
  • Parity and scope matrix: docs/specs/matrix_pixpin_parity.md
  • Integration checklist: docs/specs/integration_validation.md
  • Architecture: docs/design/system_architecture.md
  • Tradeoffs: docs/tradeoffs.md
  • Legacy spec snapshot: docs/specs/legacy/

License

MIT