Skip to content

Commit 26a2350

Browse files
committed
Update install docs to fix breakage by Homebrew/brew#21905
1 parent 37a99cb commit 26a2350

11 files changed

Lines changed: 32 additions & 46 deletions

File tree

src/content/docs/blog/android-native-swift-packages.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ Does running `swift build` and `swift test` in the package directory work from t
5454
First, install Skip and the native Android SDK by following the instructions in our [documentation](/docs/gettingstarted/). Then try to build your Swift package with the Android toolchain. The very abbreviated quick start looks like:
5555

5656
```
57+
$ brew tap skiptools/skip
58+
5759
$ brew install skiptools/skip/skip
5860
5961

src/content/docs/blog/skip-native-tech-preview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ First, ensure that you are on a macOS 14+ machine with Xcode 16, [Android Studio
3737
Next, open Terminal and type the following commands to install Skip and the native Android toolchain.
3838

3939
```
40+
brew tap skiptools/skip
4041
brew install skiptools/skip/skip
4142
skip android sdk install
4243
```

src/content/docs/docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ No, and no. The Skip build plugin runs locally on your macOS machine as part of
8282

8383
### How is Skip distributed? {#distribution}
8484

85-
The SkipStone build plugin is distributed as a binary executable artifact and driven by the Skip plugin hosted at [https://source.skip.tools/skip.git](https://source.skip.tools/skip.git). In addition, the `skip` command-line tool must be installed using the [Homebrew](https://brew.sh) command: `brew install skiptools/skip/skip`. This will install the `skip` utility that can be used to create projects and run tests, as well as the prerequisites for being able to perform local Android testing: `gradle`, `openjdk`, `android-platform-tools`, and `android-commandlinetools`.
85+
The `skipstone` build plugin is distributed as a binary executable artifact and driven by the Skip plugin hosted at [https://source.skip.tools/skip.git](https://source.skip.tools/skip.git). In addition, the `skip` command-line tool must be installed using the [Homebrew](https://brew.sh) commands: `brew tap skiptools/skip` and `brew install skiptools/skip/skip`. This will install the `skip` utility that can be used to create projects and run tests, as well as the prerequisites for being able to perform local Android testing: `gradle`, `openjdk`, `android-platform-tools`, and `android-commandlinetools`.
8686

8787
### Do Skip or any of the Skip frameworks collect data for the purposes of user tracking? {#tracking}
8888

src/content/docs/docs/gettingstarted.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ Skip requires a macOS 15+ development machine.
1313
1. Install [Xcode](https://developer.apple.com/xcode)
1414
1. Install [Android Studio](https://developer.android.com/studio)
1515
1. Install [Homebrew](https://brew.sh)
16-
1. Once Homebrew has been setup, install Skip by running the Terminal command:
16+
1. Once Homebrew has been setup, install Skip by running the Terminal commands:
1717

1818
```console
19-
brew install skiptools/skip/skip
19+
brew tap skiptools/skip
20+
brew install skip
2021
```
2122

2223
This will download and install the `skip` tool itself, along with the Android SDK and `gradle` build tool that is necessary for building and running the Android side of your apps.

src/content/docs/docs/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ A tool that automates the process of installing, upgrading, and managing softwar
452452
**Related Terms:** [SwiftPM](#swiftpm), [Gradle](#gradle)
453453

454454
### Homebrew {#homebrew}
455-
A package manager for macOS (and Linux) used to install and manage software packages. The [Skip CLI](#skip-cli) and its prerequisites are distributed via Homebrew using the command `brew install skiptools/skip/skip`.
455+
A package manager for macOS (and Linux) used to install and manage software packages. The [Skip CLI](#skip-cli) and its prerequisites are distributed via Homebrew on macOS and Linux.
456456

457457
**Related Terms:** [Skip CLI](#skip-cli), [Package Manager](#package-manager)
458458

src/content/docs/docs/modules/skip-fuse-ui/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ flowchart LR
2222
B -->|"Java_view"| C["SkipUI\n(Kotlin/Compose)"]
2323
C --> D["Jetpack Compose\nUI on Screen"]
2424
25-
style A fill:#f5f5f5,stroke:#333,color:#fff
26-
style B fill:#f0e6ff,stroke:#7b2fbe,color:#fff
27-
style C fill:#e6f0ff,stroke:#4a90d9,color:#fff
28-
style D fill:#e6ffe6,stroke:#2d8a2d,color:#fff
25+
style A fill:#555555,stroke:#333,color:#fff
26+
style B fill:#6b3fa0,stroke:#4a2d6e,color:#fff
27+
style C fill:#2e6da4,stroke:#1a4a6e,color:#fff
28+
style D fill:#2d7a2d,stroke:#1a5c1a,color:#fff
2929
```
3030

3131
The key mechanism is the `SkipUIBridging` protocol. Every SkipFuseUI view type conforms to it by exposing a `Java_view` property that returns the equivalent SkipUI Kotlin object. When Compose needs to render your view hierarchy, it walks the tree of `Java_view` references — each one backed by [SkipBridge](/docs/modules/skip-bridge/) JNI calls between Swift and Kotlin.
@@ -64,15 +64,15 @@ flowchart TB
6464
SB --> SJNI
6565
SUI --> SM
6666
67-
style APP fill:#f5f5f5,stroke:#333,color:#fff
68-
style SFUI fill:#f0e6ff,stroke:#7b2fbe,color:#fff
69-
style SSU fill:#f0e6ff,stroke:#7b2fbe,color:#fff
70-
style SB fill:#ffe6e6,stroke:#cc3333,color:#fff
71-
style SF fill:#ffe6e6,stroke:#cc3333,color:#fff
72-
style SAB fill:#ffe6e6,stroke:#cc3333,color:#fff
73-
style SJNI fill:#ffe6e6,stroke:#cc3333,color:#fff
74-
style SUI fill:#e6f0ff,stroke:#4a90d9,color:#fff
75-
style SM fill:#e6f0ff,stroke:#4a90d9,color:#fff
67+
style APP fill:#555555,stroke:#333,color:#fff
68+
style SFUI fill:#6b3fa0,stroke:#4a2d6e,color:#fff
69+
style SSU fill:#6b3fa0,stroke:#4a2d6e,color:#fff
70+
style SB fill:#b33030,stroke:#8a1a1a,color:#fff
71+
style SF fill:#b33030,stroke:#8a1a1a,color:#fff
72+
style SAB fill:#b33030,stroke:#8a1a1a,color:#fff
73+
style SJNI fill:#b33030,stroke:#8a1a1a,color:#fff
74+
style SUI fill:#2e6da4,stroke:#1a4a6e,color:#fff
75+
style SM fill:#2e6da4,stroke:#1a4a6e,color:#fff
7676
```
7777

7878
On iOS, `SkipFuseUI` simply re-exports Apple's `SwiftUI` — the entire SkipSwiftUI layer is compiled away.
@@ -109,9 +109,9 @@ flowchart LR
109109
K -->|"MutableState"| C["Compose\nRecomposition"]
110110
C -->|"read triggers\naccess()"| S
111111
112-
style S fill:#f0e6ff,stroke:#7b2fbe,color:#fff
113-
style K fill:#e6f0ff,stroke:#4a90d9,color:#fff
114-
style C fill:#e6ffe6,stroke:#2d8a2d,color:#fff
112+
style S fill:#6b3fa0,stroke:#4a2d6e,color:#fff
113+
style K fill:#2e6da4,stroke:#1a4a6e,color:#fff
114+
style C fill:#2d7a2d,stroke:#1a5c1a,color:#fff
115115
```
116116

117117
When Swift code writes to a `@State` property, the `BridgedStateBox` notifies Compose's `MutableState`, triggering recomposition. When Compose reads the value, it calls back into Swift via the bridge. This two-way sync ensures that SwiftUI's declarative state model works identically on Android.

src/content/docs/docs/modules/skip-livekit/index.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -222,13 +222,8 @@ Platform differences in property types (such as Kotlin inline classes for partic
222222

223223
## Building
224224

225-
This project is a free Swift Package Manager module that uses the
226-
Skip plugin to transpile Swift into Kotlin.
227-
228-
Building the module requires that Skip be installed using
229-
[Homebrew](https://brew.sh) with `brew install skiptools/skip/skip`.
230-
This will also install the necessary build prerequisites:
231-
Kotlin, Gradle, and the Android build tools.
225+
This project is a Swift Package Manager module that uses the
226+
Skip plugin to build the package for both iOS and Android.
232227

233228
## Testing
234229

src/content/docs/docs/modules/skip-socketio/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -343,12 +343,7 @@ Standard event name constants.
343343
## Building
344344

345345
This project is a Swift Package Manager module that uses the
346-
Skip plugin to transpile Swift into Kotlin.
347-
348-
Building the module requires that Skip be installed using
349-
[Homebrew](https://brew.sh) with `brew install skiptools/skip/skip`.
350-
This will also install the necessary build prerequisites:
351-
Kotlin, Gradle, and the Android build tools.
346+
Skip plugin to build the package for both iOS and Android.
352347

353348
## Testing
354349

src/content/docs/docs/modules/skip-sql/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -617,12 +617,7 @@ extension SQLContext {
617617
## Building
618618

619619
This project is a Swift Package Manager module that uses the
620-
Skip plugin to transpile Swift into Kotlin.
621-
622-
Building the module requires that Skip be installed using
623-
[Homebrew](https://brew.sh) with `brew install skiptools/skip/skip`.
624-
This will also install the necessary build prerequisites:
625-
Kotlin, Gradle, and the Android build tools.
620+
Skip plugin to build the package for both iOS and Android.
626621

627622
## Testing
628623

src/content/docs/docs/modules/skip-web/index.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -571,13 +571,8 @@ with features and fixes that you create, as this benefits the entire Skip commun
571571

572572
## Building
573573

574-
This project is a free Swift Package Manager module that uses the
575-
Skip plugin to transpile Swift into Kotlin.
576-
577-
Building the module requires that Skip be installed using
578-
[Homebrew](https://brew.sh) with `brew install skiptools/skip/skip`.
579-
This will also install the necessary build prerequisites:
580-
Kotlin, Gradle, and the Android build tools.
574+
This project is a Swift Package Manager module that uses the
575+
Skip plugin to build the package for both iOS and Android.
581576

582577
## Testing
583578

0 commit comments

Comments
 (0)