Skip to content

docs(readme): build instructions, limitations, corrected details - #6

Merged
mbeczynski merged 1 commit into
mainfrom
docs/readme-refresh
Oct 6, 2026
Merged

mbeczynski merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@mbeczynski

Copy link
Copy Markdown
Contributor

README audit against the code at 61445f6 (VERSION 1.2.0). The README was already in English; this fixes what was wrong or missing.

Added

  • Building the app: setup-signing-cert (optional), build-app, copy to /Applications (the launchd app agent opens that path), make-dmg, the tag-triggered release workflow (no release published yet), cloudmachine-agent version.
  • Current limitations: the Drive folder is the constant gdrive:CloudMachine/mac-studio (DriveBufferService.remotePath), so one Mac per account; machines.json limit_gb budgets are not enforced by any code; UI/CLI/log output is Polish only (Loc is unused); ad-hoc / self-signed, not notarised.
  • Requirements: Swift 5.9+ toolchain to build.

Corrected

  • Diagram: gdrive:CloudMachine/... → gdrive:CloudMachine/mac-studio.
  • drive-status sample: Wszystko wyslane → Wszystko wysłane (actual string in UploadState.headline).
  • Logs: "both rotated by size" → cloudmachine.log trimmed to the last 5,000 lines above 200 MiB; rclone.log moved to rclone.log.1 at mount start above 100 MiB. Added launchd-*.err.log.
  • GUI card name quoted in full: Poświadczenia Google Drive (OAuth 2.0).

Everything else (commands, flags, agents and intervals, thresholds, paths, Keychain service, scope, --replace-existing) was checked against the source and is accurate. Measured figures (traffic, sizes, dates) were left as written.

🤖 Generated with Claude Code

- Add "Building the app": build-app, setup-signing-cert, make-dmg, release
  workflow, the /Applications requirement and `version`.
- Add "Current limitations": fixed Drive folder (one Mac per account),
  machines.json limits not enforced, Polish-only UI, ad-hoc signing.
- Requirements: a Swift 5.9+ toolchain is needed to build.
- Diagram shows the real remote path gdrive:CloudMachine/mac-studio.
- drive-status sample quotes the real "Wszystko wysłane" string.
- Log section: exact rotation rules, launchd err logs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mbeczynski
mbeczynski merged commit 8a746be into main Oct 6, 2026
2 checks passed
@mbeczynski
mbeczynski deleted the docs/readme-refresh branch October 6, 2026 07:11
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