Skip to content

Document iOS/Xcode environment requirements #4

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 environment requirements #4

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

`CheckList` is a native **iOS** application written in Swift (Swift 3.0, iOS 10.3
deployment target). It was generated from Xcode's "Single View App" template and
currently contains only scaffolding:

- `CheckList/AppDelegate.swift` — app lifecycle + Core Data stack (`NSPersistentContainer`).
- `CheckList/ViewController.swift` — empty view controller.
- `CheckList/Base.lproj/*.storyboard` — `Main` and `LaunchScreen` storyboards.
- `CheckList/CheckList.xcdatamodeld` — an empty Core Data model.
- `CheckList.xcodeproj` — the Xcode project (single `CheckList.app` target, no test bundle).

There is no dependency manager (no `Package.swift`, `Podfile`, or Carthage),
no README, no test target, and no setup scripts.

## Cursor Cloud specific instructions

**This project cannot be built, linted, tested, or run on the Cursor Cloud
Linux VM.** It is a UIKit iOS app and depends on Apple-only frameworks and
tooling that exist exclusively on macOS:

- `import UIKit` and iOS `CoreData` — not available in the Linux Swift toolchain.
- Storyboards / asset catalogs — require `ibtool` / `actool` (bundled with Xcode).
- Build/run — require `xcodebuild` and the iOS Simulator (macOS + Xcode only).

The Linux VM has `clang` but no `swift`/`swiftc`/`xcodebuild`, and installing the
Linux Swift toolchain does **not** help because it lacks UIKit and the iOS SDK.

To develop this app you need a **macOS machine with Xcode** installed. Standard
commands there (run from the repo root):

- Open in the IDE: `open CheckList.xcodeproj`
- Build: `xcodebuild -project CheckList.xcodeproj -scheme CheckList -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 15' build`
- Run: launch the `CheckList` scheme on an iOS Simulator from Xcode (⌘R).
- Test: there is currently no test target, so `test` actions have nothing to run.

Because of this hard platform requirement, no Cursor Cloud (Linux) update script
can install dependencies for this repo — there are none to install here, and the
build/run steps are macOS-only.