Compare commits

...

7 Commits

45 changed files with 86 additions and 11 deletions
+22 -3
View File
@@ -13,6 +13,25 @@ A clear and concise description of what the bug is.
## Environment
- Host OS (macOS/Linux/WSL):
- Host OS version:
- Target iOS version:
Please provide as much of the following information as is relevant.
Host OS (macOS/Linux/WSL):
Host OS version:
<!-- macOS: Apple Logo > About this Mac -->
<!-- Linux: -->
<!-- cat /etc/*-release -->
<!-- Windows: -->
<!-- Get-WinVer; wsl -l -v -->
iOS device version:
<!-- Settings > General > About > iOS Version -->
Swift version:
<!-- swift --version -->
SDK version:
<!-- macOS: -->
<!-- xcodebuild -version; xcrun -sdk iphoneos -show-sdk-version -->
<!-- Linux/WSL: -->
<!-- swift sdk configure darwin arm64-apple-ios --show-configuration | grep -o 'iPhoneOS[0-9.]*\.sdk$' -->
+29
View File
@@ -0,0 +1,29 @@
on:
push:
branches:
- main
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: macos-15
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Build DocC
run: |
./scripts/build-docs.sh
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs'
- id: deployment
name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
+1 -1
View File
@@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
xtool@kabiroberai.com.
conduct@xtool.sh.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
+1
View File
@@ -0,0 +1 @@
/docs
+9
View File
@@ -0,0 +1,9 @@
#!/bin/bash
set -euo pipefail
rm -rf docs
swift package --allow-writing-to-package-directory \
generate-documentation --target XToolDocs --disable-indexing \
--output-path docs
+3
View File
@@ -161,5 +161,8 @@ let package = Package(
],
cSettings: cSettings
),
.executableTarget(
name: "XToolDocs"
),
]
)
+4 -4
View File
@@ -15,15 +15,15 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
## Getting Started
1. Follow the guide to install `xtool`
- [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)!
- [Installation (Linux/Windows)](https://xtool.sh/documentation/xtooldocs/installation-linux)
- [Installation (macOS)](https://xtool.sh/documentation/xtooldocs/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://xtool.sh/tutorials/xtooldocs/first-app)!
## Examples
### Screenshot
![A screenshot of xtool being invoked from VSCode](Sources/xtool/Documentation.docc/Resources/Cover.png)
![A screenshot of xtool being invoked from VSCode](Sources/XToolDocs/Documentation.docc/Resources/Cover.png)
### Command line interface
@@ -78,7 +78,7 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
data: .init(
_type: .profiles,
attributes: .init(
name: "SC profile \(bundleID.id)",
name: "XTL profile \(bundleID.id)",
profileType: .iosAppDevelopment
),
relationships: .init(
@@ -21,7 +21,7 @@ You can update your app's bundle ID by editing the `bundleID` field in `xtool.ym
> Note:
>
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `SC-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `XTL-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
>
> With additional engineering effort, this limitation could be lifted for paid Developer Program users by leveraging wildcard provisioning profiles. If you have a concrete use case for this and/or wish to contribute, please [file an issue](https://github.com/xtool-org/xtool/issues/new).
@@ -1,9 +1,15 @@
# ``xtool``
# ``XToolDocs``
@Metadata {
@DisplayName("xtool")
}
Cross-platform Xcode replacement.
## Overview
[View on GitHub](https://github.com/xtool-org/xtool)
xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functionality with open standards.
✅ Build a SwiftPM package into an iOS app

Before

Width:  |  Height:  |  Size: 286 KiB

After

Width:  |  Height:  |  Size: 286 KiB

Before

Width:  |  Height:  |  Size: 948 KiB

After

Width:  |  Height:  |  Size: 948 KiB

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 5.0 MiB

After

Width:  |  Height:  |  Size: 5.0 MiB

Before

Width:  |  Height:  |  Size: 222 KiB

After

Width:  |  Height:  |  Size: 222 KiB

Before

Width:  |  Height:  |  Size: 316 KiB

After

Width:  |  Height:  |  Size: 316 KiB

Before

Width:  |  Height:  |  Size: 232 KiB

After

Width:  |  Height:  |  Size: 232 KiB

Before

Width:  |  Height:  |  Size: 142 KiB

After

Width:  |  Height:  |  Size: 142 KiB

Before

Width:  |  Height:  |  Size: 2.3 MiB

After

Width:  |  Height:  |  Size: 2.3 MiB

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 127 KiB

View File
+8
View File
@@ -0,0 +1,8 @@
[build]
# by setting a custom base directory, we prevent Netlify from running
# `swift build` in the root directory, which builds more targets than
# we need.
base = "Netlify/"
publish = "docs/"
command = "./build.sh"
environment = { SWIFT_VERSION = "6.1" }