From b4404683e1116ed7a162665ecc44f999aede464f Mon Sep 17 00:00:00 2001 From: Philip Niedertscheider Date: Wed, 14 Oct 2026 13:03:09 +0200 Subject: [PATCH] docs: Remove duplicated version requirements --- AGENTS.md | 3 ++- README.md | 2 +- docs/DEVELOPMENT.md | 8 ++++---- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index f3d3a0f..5b765c6 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,7 +2,8 @@ ## Scope -- This is a Swift 6.3 command-line package targeting macOS 13 or later. +- This is a Swift command-line package. +- Do not duplicate toolchain or deployment-target versions in prose documentation. - Use SwiftPM for dependencies and the Makefile for standard development workflows. - Keep the CLI stateless. Commands must receive the technology they operate on. - Do not add or update dependencies unless the requested change requires it. diff --git a/README.md b/README.md index 3fdc8e7..493303d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ ## Installation -On **macOS 13+**, install with Homebrew: +On macOS, install with Homebrew: ```bash brew install techprimate/tap/apple-docs diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index de440c8..b40ee31 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -2,7 +2,7 @@ ## Prerequisites -- Swift 6.3 or later and Make. CI and Linux containers use Swift 6.4.0. +- Swift and Make. - Homebrew for `make init`, which installs actionlint, dprint, pre-commit, and SwiftLint. - Docker for container-based Linux build and test targets. @@ -42,7 +42,7 @@ pre-commit install | `make run ARGS="types view Button --technology SwiftUI"` | Run the executable through SwiftPM. | | `make build` | Build the release binary at `dist/apple-docs`. | | `make test` | Run the test suite. | -| `make test-linux` | Run tests in pinned Swift 6.4.0 containers for amd64 and arm64. | +| `make test-linux` | Run tests in pinned Swift containers for amd64 and arm64. | | `make test-integration` | Build the release binary and run live tests against Apple documentation. Requires internet access. | | `make analyze` | Run SwiftLint, formatting checks, and actionlint. | | `make format` | Format Swift with `swift format` and JSON, YAML, Markdown, and TOML with dprint. | @@ -54,14 +54,14 @@ Container commands mount the source read-only and keep build products in Docker ```bash make test-linux-amd64 -make test-linux-arm64 TEST_ARGS="--filter AppleDocumentationClientSearchTests" +make test-linux-arm64 TEST_ARGS="--filter AppleDocumentationRepositorySearchTests" make build-linux-native make test-integration-linux ``` Live integration tests require internet access. Both integration targets accept `INTEGRATION_FILTER=SuiteName`. `make test` also accepts `TEST_ARGS`. -For static release builds, use the matching Swift.org 6.4.0 toolchain, not Xcode's bundled compiler: +For static release builds, use a Swift.org toolchain matching the SDK configured in the Makefile, not Xcode's bundled compiler: ```bash make install-linux-sdk