From 54242ad4ea2c1cf9dc3b0e4a5d9a00042fb29999 Mon Sep 17 00:00:00 2001 From: harsha balakrishnan Date: Sun, 11 Oct 2026 14:54:46 +0530 Subject: [PATCH] docs: fix release badge, add develop/test section, add AGENTS.md --- AGENTS.md | 9 +++++++++ README.md | 13 ++++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..2163afc --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,9 @@ +# AGENTS.md + +Lively: native macOS 14+ menu bar app for looping video wallpapers (Swift 6, no third-party deps). + +- Layout: `Sources/Lively` (LivelyCore: Core, Logic, UI), `Sources/LivelyApp/main.swift`, `Tests/LivelyTests`. +- Build/test: `swift build`, `swift test`. Package app: `./package.sh`; DMG: `./scripts/make-dmg.sh`. +- Design/brand: see `DESIGN.md`, `PRODUCT.md`, `brand.md`. Use `LivelyBrand` tokens, not inline literals. +- Privacy: offline by default; the only network call is the opt-in GitHub update check. Keep it that way. +- Not sandboxed by design (draws below desktop icons). Do not commit secrets, signing material, or personal paths. diff --git a/README.md b/README.md index 6a78cf6..2f18c3d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-teal.svg)](LICENSE) [![macOS 14+](https://img.shields.io/badge/macOS-14%2B-blue.svg)](https://www.apple.com/macos/) -[![Release](https://github.com/harshabala/Lively/releases)](https://github.com/harshabala/Lively/releases) +[![Release](https://img.shields.io/github/v/release/harshabala/lively)](https://github.com/harshabala/lively/releases) **Video wallpapers for your Mac.** @@ -100,6 +100,17 @@ DMG with drag-to-Applications: Needs Xcode or Command Line Tools. +## Develop and test + +Lively is a Swift package (`LivelyCore` library, `LivelyApp` executable, `LivelyTests`). + +```bash +swift build # debug build +swift test # unit tests (CI runs the same on macOS 15 / Xcode 26.3) +``` + +Release packaging lives in `scripts/release.sh`; `scripts/smoke_verify.sh` smoke-checks a built app. + ## Privacy Assignments stay on your Mac. Security-scoped bookmarks remember the files you chose. No analytics. Lively makes no network requests unless you turn on **Check for Updates** (off by default), which asks the GitHub Releases API for the latest version at launch. Note: Lively is not sandboxed (it has to draw below the desktop icons), so this is a promise kept by the code rather than enforced by an entitlement.