Skip to content

armgit / xtool

Public Imported from GitHub
0

Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.

agents: check in lightweight AGENTS.md (#245)

Kabir Oberaiae2bef7bbae6
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..7d9f8f1
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,16 @@
+# About
+
+xtool is a cross-platform replacement for Xcode (including build system, provisioning, deployment).
+
+The `xtool` CLI supports macOS, Linux, WSL. The lower-level XKit (provisioning and device interaction) library additionally supports iOS.
+
+## Development
+
+- The majority of the code is in the Swift Package. You can use `swift build` / `swift test` / etc for iteration.
+- Caveat: on macOS, xtool is distributed as an app bundle (allows entitlements like Keychain). To build the Mac app, use `make mac`. You can then invoke the CLI at `./macOS/Build/xtool`.
+- Make sure to run `make lint` (swiftlint) when you're done
+
+## Conventions
+
+- Use modern Swift 6. Strict concurrency is enabled.
+- Use swift-dependencies for Dependency Injection. Passing dependencies around as arguments is an anti-pattern.
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000..43c994c
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1 @@