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.

Add WSL info

Kabir Oberaibc0e195ba343
diff --git a/README.md b/README.md
index 77b353b..70460a3 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# xtool
-Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux and macOS.
+Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, and macOS.
## Overview
@@ -15,7 +15,7 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
## Getting Started
1. Follow the guide to install `xtool`
- - [Installation (Linux)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-linux)
+ - [Installation (Linux/Windows)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-linux)
- [Installation (macOS)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://swiftpackageindex.com/xtool-org/xtool/tutorials/xtool/first-app)!
diff --git a/Sources/xtool/Documentation.docc/First-app.tutorial b/Sources/xtool/Documentation.docc/First-app.tutorial
index 0078586..396c221 100644
--- a/Sources/xtool/Documentation.docc/First-app.tutorial
+++ b/Sources/xtool/Documentation.docc/First-app.tutorial
@@ -1,6 +1,6 @@
@Tutorial(time: 30) {
- @Intro(title: "Build your first iOS app on Linux") {
- Once you've completed <doc:Installation-Linux>, use xtool to build and deploy an iOS app from your Linux machine.
+ @Intro(title: "Build your first iOS app on Linux / Windows") {
+ Once you've completed <doc:Installation-Linux>, use xtool to build and deploy an iOS app from your Linux/Windows machine.
}
@Section(title: "Create an xtool project") {
@@ -118,7 +118,7 @@
@Step {
Follow the instructions to configure [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp/blob/242609dcad55824d9eb23269c0aeead187fd0faa/Documentation/Editor%20Integration.md) for your IDE.
- For example, if you're using Visual Studio Code, this means you need to install the [Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode).
+ For example, if you're using Visual Studio Code, this means you need to install the [Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode). If you're on Windows, make sure you're [connected to the WSL remote](https://code.visualstudio.com/docs/remote/wsl).
@Image(source: "SwiftExtension", alt: "Swift extension for VSCode")
}
diff --git a/Sources/xtool/Documentation.docc/Installation-Linux.md b/Sources/xtool/Documentation.docc/Installation-Linux.md
index c015861..12c3181 100644
--- a/Sources/xtool/Documentation.docc/Installation-Linux.md
+++ b/Sources/xtool/Documentation.docc/Installation-Linux.md
@@ -1,13 +1,19 @@
-# Installation (Linux)
+# Installation (Linux/Windows)
-Set up xtool for iOS app development on Linux.
+Set up xtool for iOS app development on Linux or Windows.
## Overview
-This article outlines the steps to install `xtool` and begin developing iOS apps on Linux.
+This article outlines the steps to install `xtool` and begin developing iOS apps on Linux (or Windows via WSL).
## Prerequisites
+### WSL (for Windows users)
+
+If you're on Windows, you can use xtool via [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) (WSL).
+
+Once you install WSL, you'll also need to set up USB passthrough. See Microsoft's instructions on [installing USBIPD](https://learn.microsoft.com/en-us/windows/wsl/connect-usb). Make sure you're able to bind your iOS device to WSL via USB.
+
### Swift
Install the Swift 6.1 toolchain for your Linux distribution from <https://swift.org/install/linux>.