Skip to content

docs: README fixes and AGENTS.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harshabala merged 1 commit into from
Oct 11, 2026
Merged

docs: README fixes and AGENTS.md #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

Expand Down Expand Up @@ -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.
Expand Down
Loading