From 1890a162125aa58ac849654743447595ef759e39 Mon Sep 17 00:00:00 2001 From: Kabir Oberai Date: Wed, 7 May 2025 15:39:27 +0530 Subject: [PATCH 1/5] Better readme --- README.md | 54 ++---------------- .../XTool/Documentation.docc/Documentation.md | 15 +++-- .../Documentation.docc/Resources/Cover.png | Bin 3 files changed, 15 insertions(+), 54 deletions(-) rename Assets/Screenshot.png => Sources/XTool/Documentation.docc/Resources/Cover.png (100%) diff --git a/README.md b/README.md index 1d6ef7ea..8149642b 100644 --- a/README.md +++ b/README.md @@ -12,53 +12,11 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona ✅ Interact with Apple Developer Services programmatically -![A screenshot of xtool being invoked from VSCode](Assets/Screenshot.png) +![A screenshot of xtool being invoked from VSCode](Sources/XTool/Documentation.docc/Resources/Cover.png) -## Usage +## Getting Started -- xtool works out of the box on macOS. -- On Linux, you'll need the development packages of [libimobiledevice](https://github.com/libimobiledevice/libimobiledevice) + its dependencies. - - Alternatively, we provide a Dockerfile that does this for you. See [Linux/README.md](/Linux/README.md). - -## Installation (CLI) - -```bash -$ git clone https://github.com/xtool-org/xtool -$ cd xtool -$ swift run xtool --help -OVERVIEW: Cross-platform Xcode replacement - -USAGE: xtool - -OPTIONS: - -h, --help Show help information. - -CONFIGURATION SUBCOMMANDS: - setup Set up xtool for iOS development - auth Manage Apple Developer Services authentication - sdk Manage the Darwin Swift SDK - -DEVELOPMENT SUBCOMMANDS: - new Create a new xtool SwiftPM project - dev Build and run an xtool SwiftPM project - ds Interact with Apple Developer Services - -DEVICE SUBCOMMANDS: - devices List devices - install Install an ipa file to your device - uninstall Uninstall an installed app - launch Launch an installed app - - See 'xtool help ' for detailed help. -``` - -## Installation (Library) - -xtool includes a library that you can use to interact with Apple Developer Services, iOS devices, and more from your own app. You can use this by adding `XKit` as a SwiftPM dependency. - -```swift -// package dependency: -.package(url: "https://github.com/xtool-org/xtool", .upToNextMinor(from: "1.2.0")) -// target dependency: -.product(name: "XKit", package: "xtool") -``` +1. Follow the guide to install `xtool` + - [Linux](#) + - macOS: TBD +2. Create and run your first xtool-powered app by following the [tutorial](#)! diff --git a/Sources/XTool/Documentation.docc/Documentation.md b/Sources/XTool/Documentation.docc/Documentation.md index 85836807..7556e782 100644 --- a/Sources/XTool/Documentation.docc/Documentation.md +++ b/Sources/XTool/Documentation.docc/Documentation.md @@ -1,15 +1,18 @@ # ``xtool`` -The `xtool` command line interface (CLI). +Cross-platform Xcode replacement. ## Overview -You can use `xtool` to interact with iOS applications and Apple Developer Services, including +xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functionality with open standards. -- Building a Swift Package into an iOS app on **macOS or Linux**. -- Managing Codesigning Certificates, Devices, App Identifiers, and Provisioning Profiles across both free and paid Apple Developer accounts. -- Codesigning a `.ipa`. -- Installing a `.ipa` on your iOS device. +✅ Build a SwiftPM package into an iOS app + +✅ Sign and install iOS apps + +✅ Interact with Apple Developer Services programmatically + +![A screenshot of xtool being invoked from VSCode](Cover.png) ## Topics diff --git a/Assets/Screenshot.png b/Sources/XTool/Documentation.docc/Resources/Cover.png similarity index 100% rename from Assets/Screenshot.png rename to Sources/XTool/Documentation.docc/Resources/Cover.png From 2da6829629be9c033c87ed8775aba174e95f2b71 Mon Sep 17 00:00:00 2001 From: Kabir Oberai Date: Wed, 7 May 2025 15:44:08 +0530 Subject: [PATCH 2/5] Update readme --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8149642b..585bd9ce 100644 --- a/README.md +++ b/README.md @@ -19,4 +19,45 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona 1. Follow the guide to install `xtool` - [Linux](#) - macOS: TBD -2. Create and run your first xtool-powered app by following the [tutorial](#)! +2. Create and run your first xtool-powered app by following the [tutorial](#) + +## Use xtool via the command line + +```bash +$ xtool --help +OVERVIEW: Cross-platform Xcode replacement + +USAGE: xtool + +OPTIONS: + -h, --help Show help information. + +CONFIGURATION SUBCOMMANDS: + setup Set up xtool for iOS development + auth Manage Apple Developer Services authentication + sdk Manage the Darwin Swift SDK + +DEVELOPMENT SUBCOMMANDS: + new Create a new xtool SwiftPM project + dev Build and run an xtool SwiftPM project + ds Interact with Apple Developer Services + +DEVICE SUBCOMMANDS: + devices List devices + install Install an ipa file to your device + uninstall Uninstall an installed app + launch Launch an installed app + + See 'xtool help ' for detailed help. +``` + +## …or as a library! + +xtool includes a library that you can use to interact with Apple Developer Services, iOS devices, and more from your own app. You can use this by adding `XKit` as a SwiftPM dependency. + +```swift +// package dependency: +.package(url: "https://github.com/xtool-org/xtool", .upToNextMinor(from: "1.2.0")) +// target dependency: +.product(name: "XKit", package: "xtool") +``` From c248adb605a4100dbac75bb375e029b701e93763 Mon Sep 17 00:00:00 2001 From: Kabir Oberai Date: Wed, 7 May 2025 15:49:14 +0530 Subject: [PATCH 3/5] More readme improvements --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 585bd9ce..4e945a08 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,20 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona ✅ Interact with Apple Developer Services programmatically -![A screenshot of xtool being invoked from VSCode](Sources/XTool/Documentation.docc/Resources/Cover.png) - ## Getting Started 1. Follow the guide to install `xtool` - - [Linux](#) - - macOS: TBD -2. Create and run your first xtool-powered app by following the [tutorial](#) + - [Installation (Linux)](#) + - Installation (macOS): TBD +2. Create and run your first xtool-powered app by following the [tutorial](#)! -## Use xtool via the command line +## Examples + +### Screenshot + +![A screenshot of xtool being invoked from VSCode](Sources/XTool/Documentation.docc/Resources/Cover.png) + +### Command line interface ```bash $ xtool --help @@ -51,7 +55,7 @@ DEVICE SUBCOMMANDS: See 'xtool help ' for detailed help. ``` -## …or as a library! +### Library xtool includes a library that you can use to interact with Apple Developer Services, iOS devices, and more from your own app. You can use this by adding `XKit` as a SwiftPM dependency. From 1dd9fbcd733eb4dbf75f7eebdc046b47fee8fe32 Mon Sep 17 00:00:00 2001 From: Kabir Oberai Date: Wed, 7 May 2025 18:05:46 +0530 Subject: [PATCH 4/5] We also have a macOS guide now --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e945a08..c943f04e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona 1. Follow the guide to install `xtool` - [Installation (Linux)](#) - - Installation (macOS): TBD + - [Installation (macOS)](#) 2. Create and run your first xtool-powered app by following the [tutorial](#)! ## Examples From fae1137f5cc9f0187655b0ab4793dc211cc63474 Mon Sep 17 00:00:00 2001 From: Kabir Oberai Date: Wed, 7 May 2025 18:56:09 +0530 Subject: [PATCH 5/5] =?UTF-8?q?Just=20link=20SPI=20until=20it=E2=80=99s=20?= =?UTF-8?q?updated?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index c943f04e..34b7f3b4 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,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)](#) - - [Installation (macOS)](#) -2. Create and run your first xtool-powered app by following the [tutorial](#)! +View the documentation on [Swift Package Index](https://swiftpackageindex.com/xtool-org/xtool). ## Examples