Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.
Better readme
Kabir Oberai1890a162125a
diff --git a/README.md b/README.mdindex 1d6ef7e..8149642 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-+-## 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 <subcommand>--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 <subcommand>' 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.mdindex 8583680..7556e78 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++## Topicsdiff --git a/Assets/Screenshot.png b/Sources/XTool/Documentation.docc/Resources/Cover.pngsimilarity index 100%rename from Assets/Screenshot.pngrename to Sources/XTool/Documentation.docc/Resources/Cover.png