Skip to content

Document iOS/Xcode dev environment setup (macOS-only) #6

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

Draft
aj327 wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Document iOS/Xcode dev environment setup (macOS-only) #6

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
33 changes: 33 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# CheckList

A native **iOS** application written in Swift, built with Xcode. Uses UIKit + Storyboards
for the UI and Core Data (`NSPersistentContainer(name: "CheckList")`) for local persistence.

There is no backend, no server, no external API, and no third-party dependency manager
(no CocoaPods `Podfile`, no Swift Package Manager `Package.swift`, no Carthage `Cartfile`).
The app only links Apple system frameworks (`UIKit`, `CoreData`).

## Building / Running (requires macOS + Xcode)

This project targets the iOS SDK (`SDKROOT = iphoneos`, `IPHONEOS_DEPLOYMENT_TARGET = 10.3`,
`SWIFT_VERSION = 3.0`). It can only be built and run on **macOS with Xcode installed**:

- Open in Xcode: `open CheckList.xcodeproj`
- Run: select the `CheckList` scheme and run on the iOS Simulator or a device.
- Command line (macOS): `xcodebuild -project CheckList.xcodeproj -scheme CheckList -sdk iphonesimulator build`
- Tests: there is **no test target** defined, so there are no automated tests to run.
- There are **no dependencies to install** — no `pod install` / `swift package resolve` / `npm install` step exists or is needed.

## Cursor Cloud specific instructions

- Cursor Cloud agents run on a **Linux** VM. This is a native iOS/Xcode app and **cannot be
built, run, linted, or tested on Linux** — iOS development requires macOS with Xcode, the
iOS SDK, and the iOS Simulator, none of which are available (or installable) on Linux.
- The app imports `UIKit` and `CoreData` and uses `@UIApplicationMain` + Storyboards. Even the
open-source Swift toolchain for Linux would not help, because those Apple frameworks and the
Simulator do not exist on Linux.
- There is **nothing to install** on the VM: no package manager, no lockfile, no external
services or databases (Core Data's SQLite store is created automatically on-device at
runtime). The startup update script is intentionally a no-op.
- To actually develop/build/run/test this app, use a Mac with Xcode (see the "Building /
Running" section above). Do not attempt to spin up a build/run on the Linux cloud VM.