mirror of
https://github.com/cottongin/cardputerzero-sync.git
synced 2026-11-20 14:44:47 -06:00
docs: add build, installation, usage, and troubleshooting documentation
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
# 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
|
||||
|
||||
1. **Git Branch Integration:**
|
||||
- Created `master` at `23db23a`, fast-forward merged `feat/cardputerzero-photo-sync` (`19bb127`), and deleted `feat/cardputerzero-photo-sync`.
|
||||
2. **[README.md](../README.md):**
|
||||
- Added architecture summary, 3-step quick start (Mac `LaunchAgent`, ARM64 `.deb`, `Photo Sync` Tailscale target pairing), keyboard shortcut reference table, documentation links, and repository layout.
|
||||
3. **[docs/building-and-installation.md](../docs/building-and-installation.md):**
|
||||
- Documented macOS and CardputerZero prerequisites, optional `.ttf` font bundling (`/usr/share/cp0-sync/fonts/`), building `cp0-sync_1.0.0_m5stack1_arm64.deb` via Docker (`./packaging/build-deb.sh`) or natively (`--local`), `dpkg` install/uninstall lifecycle, macOS `LaunchAgent` install/symlink setup, macOS SDL2 simulator builds (`--sim`, `--render-test`, CMake flags), and running all 4 test suites.
|
||||
4. **[docs/usage-and-operations.md](../docs/usage-and-operations.md):**
|
||||
- Documented `cp0-mac-sync` CLI commands (`status`, `set-dir`, `set-port`, `logs`, `install-service`, `uninstall-service`), `cp0-mac-receiver` foreground flags, atomic `.part` + collision rename rules, CardputerZero UI status pills/tabs/modals, `cp0-syncd` filtering/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.
|
||||
|
||||
---
|
||||
|
||||
## Verification
|
||||
|
||||
- `python3 -m unittest discover -s packaging/tests -v`: `7/7` passed (`0.241s`, `OK`).
|
||||
- `ctest --test-dir device-ui/build -R test_ui_navigation --output-on-failure -V`: `1/1` passed (`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.deb` via `./packaging/build-deb.sh` (or `./packaging/build-deb.sh --local` on device) when deploying to CardputerZero.
|
||||
Reference in New Issue
Block a user