Skip to content

docs: Remove duplicated version requirements #50

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
philprime merged 1 commit into from
Oct 14, 2026
Merged

docs: Remove duplicated version requirements #50

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
3 changes: 2 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

## Installation

On **macOS 13+**, install with Homebrew:
On macOS, install with Homebrew:

```bash
brew install techprimate/tap/apple-docs
Expand Down
8 changes: 4 additions & 4 deletions docs/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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