mirror of
https://github.com/cottongin/cardputerzero-sync.git
synced 2026-11-21 06:54:48 -06:00
2.7 KiB
2.7 KiB
Master Merge & Documentation Summary
Date: 2026-11-18 09:33 EST
Branch: master (fast-forward merged from feat/cardputerzero-photo-sync at 19bb127)
Task Description
Merged feat/cardputerzero-photo-sync locally into master, deleted the feature branch, and created top-level and /docs/ documentation covering building, installing, configuring, running, and troubleshooting CardputerZero Photo Sync.
Changes Made
- Git Branch Integration:
- Created
masterat23db23a, fast-forward mergedfeat/cardputerzero-photo-sync(19bb127), and deletedfeat/cardputerzero-photo-sync.
- Created
- README.md:
- Added architecture summary, 3-step quick start (Mac
LaunchAgent, ARM64.deb,Photo SyncTailscale target pairing), keyboard shortcut reference table, documentation links, and repository layout.
- Added architecture summary, 3-step quick start (Mac
- docs/building-and-installation.md:
- Documented macOS and CardputerZero prerequisites, optional
.ttffont bundling (/usr/share/cp0-sync/fonts/), buildingcp0-sync_1.0.0_m5stack1_arm64.debvia Docker (./packaging/build-deb.sh) or natively (--local),dpkginstall/uninstall lifecycle, macOSLaunchAgentinstall/symlink setup, macOS SDL2 simulator builds (--sim,--render-test, CMake flags), and running all 4 test suites.
- Documented macOS and CardputerZero prerequisites, optional
- docs/usage-and-operations.md:
- Documented
cp0-mac-syncCLI commands (status,set-dir,set-port,logs,install-service,uninstall-service),cp0-mac-receiverforeground flags, atomic.part+ collision rename rules, CardputerZero UI status pills/tabs/modals,cp0-syncdfiltering/extensions/backoff(5, 10, 20, 40, 60)behavior, config schemas & environment variables (CP0_MAC_CONFIG,CP0_SYNC_CONFIG,CP0_SYNC_DB,CP0_SYNC_SOCK,CP0_FONT_SANS,CP0_FONT_MONO,CP0_FB_DEVICE,CP0_EVDEV_DEVICE), and troubleshooting steps.
- Documented
Verification
python3 -m unittest discover -s packaging/tests -v:7/7passed (0.241s,OK).ctest --test-dir device-ui/build -R test_ui_navigation --output-on-failure -V:1/1passed (0.01 sec).
Lessons Learned
- Verified every CLI flag (
bin/cp0-mac-receiver--config/--log-file), environment variable (CP0_MAC_CONFIG,CP0_SYNC_*,CP0_FB_DEVICE,CP0_EVDEV_DEVICE), backoff tuple ((5, 10, 20, 40, 60)), and UI badge directly against the source files prior to writing docs so examples match the implementation byte-for-byte.
Follow-Up Items
- Build
packaging/dist/cp0-sync_1.0.0_m5stack1_arm64.debvia./packaging/build-deb.sh(or./packaging/build-deb.sh --localon device) when deploying to CardputerZero.