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.

Turn first-app into a DocC tutorial

Kabir Oberai61b6cdd9a719
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/build-1a.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-1a.sh
new file mode 100644
index 0000000..7221878
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-1a.sh
@@ -0,0 +1,5 @@
+Hello$
+Planning...
+Building for debugging...
+[8/8] Linking Hello-App
+Build of product 'Hello-App' complete! (4.94s)
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/build-1b.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-1b.sh
new file mode 100644
index 0000000..ce9fd38
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-1b.sh
@@ -0,0 +1,5 @@
+Hello$ supersign dev
+Planning...
+Building for debugging...
+[8/8] Linking Hello-App
+Build of product 'Hello-App' complete! (4.94s)
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/build-2.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-2.sh
new file mode 100644
index 0000000..b183302
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-2.sh
@@ -0,0 +1,6 @@
+Hello$ supersign dev
+Planning...
+Building for debugging...
+[8/8] Linking Hello-App
+Build of product 'Hello-App' complete! (4.94s)
+Waiting for device to be connected...
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/build-3.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-3.sh
new file mode 100644
index 0000000..dedff25
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/build-3.sh
@@ -0,0 +1,17 @@
+Hello$ supersign dev
+Planning...
+Building for debugging...
+[8/8] Linking Hello-App
+Build of product 'Hello-App' complete! (4.94s)
+Waiting for device to be connected...
+Installing to device: Kabir's iPhone (udid: *****)
+
+[Unpacking app] 100%
+[Logging in] 100%
+[Preparing device] 100%
+[Provisioning] 100%
+[Signing] 100%
+[Packaging] 100%
+[Connecting] 100%
+[Installing] 100%
+[Verifying] 100%
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/edit-2.swift b/Sources/SupersignCLI/Documentation.docc/First-app-code/edit-2.swift
new file mode 100644
index 0000000..acf0f45
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/edit-2.swift
@@ -0,0 +1,13 @@
+import SwiftUI
+
+struct ContentView: View {
+ var body: some View {
+ VStack {
+ Image(systemName: "globe")
+ .imageScale(.large)
+ .foregroundStyle(.tint)
+ Text("Hello, world!")
+ }
+ .padding()
+ }
+}
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/edit-4.swift b/Sources/SupersignCLI/Documentation.docc/First-app-code/edit-4.swift
new file mode 100644
index 0000000..100d567
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/edit-4.swift
@@ -0,0 +1,15 @@
+import SwiftUI
+
+struct ContentView: View {
+ var body: some View {
+ VStack {
+ Image(systemName: "globe")
+ .imageScale(.large)
+ .foregroundStyle(.tint)
+ Text("Hello, world!")
+ .bold()
+ .foregroundStyle(.purple)
+ }
+ .padding()
+ }
+}
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-5a.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-5a.sh
new file mode 100644
index 0000000..d73f7cb
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-5a.sh
@@ -0,0 +1,17 @@
+Hello$
+Planning...
+Building for debugging...
+[8/8] Linking Hello-App
+Build of product 'Hello-App' complete! (5s)
+Waiting for device to be connected...
+Installing to device: Kabir's iPhone (udid: *****)
+
+[Unpacking app] 100%
+[Logging in] 100%
+[Preparing device] 100%
+[Provisioning] 100%
+[Signing] 100%
+[Packaging] 100%
+[Connecting] 100%
+[Installing] 100%
+[Verifying] 100%
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-5b.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-5b.sh
new file mode 100644
index 0000000..dc77cbe
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-5b.sh
@@ -0,0 +1,17 @@
+Hello$ supersign dev
+Planning...
+Building for debugging...
+[8/8] Linking Hello-App
+Build of product 'Hello-App' complete! (5s)
+Waiting for device to be connected...
+Installing to device: Kabir's iPhone (udid: *****)
+
+[Unpacking app] 100%
+[Logging in] 100%
+[Preparing device] 100%
+[Provisioning] 100%
+[Signing] 100%
+[Packaging] 100%
+[Connecting] 100%
+[Installing] 100%
+[Verifying] 100%
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-6.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-6.sh
new file mode 100644
index 0000000..dc77cbe
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/rerun-6.sh
@@ -0,0 +1,17 @@
+Hello$ supersign dev
+Planning...
+Building for debugging...
+[8/8] Linking Hello-App
+Build of product 'Hello-App' complete! (5s)
+Waiting for device to be connected...
+Installing to device: Kabir's iPhone (udid: *****)
+
+[Unpacking app] 100%
+[Logging in] 100%
+[Preparing device] 100%
+[Provisioning] 100%
+[Signing] 100%
+[Packaging] 100%
+[Connecting] 100%
+[Installing] 100%
+[Verifying] 100%
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-1a.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-1a.sh
new file mode 100644
index 0000000..9ab3ab2
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-1a.sh
@@ -0,0 +1,10 @@
+Developer$
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-1b.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-1b.sh
new file mode 100644
index 0000000..968dd64
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-1b.sh
@@ -0,0 +1,10 @@
+Developer$ supersign dev new Hello
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-2a.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-2a.sh
new file mode 100644
index 0000000..fc16d5b
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-2a.sh
@@ -0,0 +1,19 @@
+Developer$ supersign dev new Hello
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
+
+Developer$
+Hello$
+-rw-rw-r-- 1 user user 187 .gitignore
+drwxrwxr-x 2 user user 4096 .sourcekit-lsp
+-rw-rw-r-- 1 user user 463 Package.swift
+drwxrwxr-x 3 user user 4096 Sources
+drwxrwxr-x 4 user user 4096 supersign
+-rw-rw-r-- 1 user user 39 supersign.yml
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-2b.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-2b.sh
new file mode 100644
index 0000000..1b7e30a
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-2b.sh
@@ -0,0 +1,19 @@
+Developer$ supersign dev new Hello
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
+
+Developer$ cd Hello
+Hello$ ls -la
+-rw-rw-r-- 1 user user 187 .gitignore
+drwxrwxr-x 2 user user 4096 .sourcekit-lsp
+-rw-rw-r-- 1 user user 463 Package.swift
+drwxrwxr-x 3 user user 4096 Sources
+drwxrwxr-x 4 user user 4096 supersign
+-rw-rw-r-- 1 user user 39 supersign.yml
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-3a.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-3a.sh
new file mode 100644
index 0000000..2f85077
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-3a.sh
@@ -0,0 +1,23 @@
+Developer$ supersign dev new Hello
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
+
+Developer$ cd Hello
+Hello$ ls -la
+-rw-rw-r-- 1 user user 187 .gitignore
+drwxrwxr-x 2 user user 4096 .sourcekit-lsp
+-rw-rw-r-- 1 user user 463 Package.swift
+drwxrwxr-x 3 user user 4096 Sources
+drwxrwxr-x 4 user user 4096 supersign
+-rw-rw-r-- 1 user user 39 supersign.yml
+
+Hello$
+version: 1
+bundleID: com.example.Hello
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-3b.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-3b.sh
new file mode 100644
index 0000000..d0b1f88
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-3b.sh
@@ -0,0 +1,23 @@
+Developer$ supersign dev new Hello
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
+
+Developer$ cd Hello
+Hello$ ls -la
+-rw-rw-r-- 1 user user 187 .gitignore
+drwxrwxr-x 2 user user 4096 .sourcekit-lsp
+-rw-rw-r-- 1 user user 463 Package.swift
+drwxrwxr-x 3 user user 4096 Sources
+drwxrwxr-x 4 user user 4096 supersign
+-rw-rw-r-- 1 user user 39 supersign.yml
+
+Hello$ cat supersign.yml
+version: 1
+bundleID: com.example.Hello
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-4a.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-4a.sh
new file mode 100644
index 0000000..af93495
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-4a.sh
@@ -0,0 +1,26 @@
+Developer$ supersign dev new Hello
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
+
+Developer$ cd Hello
+Hello$ ls -la
+-rw-rw-r-- 1 user user 187 .gitignore
+drwxrwxr-x 2 user user 4096 .sourcekit-lsp
+-rw-rw-r-- 1 user user 463 Package.swift
+drwxrwxr-x 3 user user 4096 Sources
+drwxrwxr-x 4 user user 4096 supersign
+-rw-rw-r-- 1 user user 39 supersign.yml
+
+Hello$ cat supersign.yml
+version: 1
+bundleID: com.example.Hello
+
+Hello$
+{ "swiftPM": { "swiftSDK": "arm64-apple-ios" } }
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app-code/template-4b.sh b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-4b.sh
new file mode 100644
index 0000000..7d198f6
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app-code/template-4b.sh
@@ -0,0 +1,26 @@
+Developer$ supersign dev new Hello
+Creating package: Hello
+Creating Package.swift
+Creating supersign.yml
+Creating .gitignore
+Creating .sourcekit-lsp/config.json
+Creating Sources/Hello/HelloApp.swift
+Creating Sources/Hello/ContentView.swift
+
+Finished generating project Hello.
+
+Developer$ cd Hello
+Hello$ ls -la
+-rw-rw-r-- 1 user user 187 .gitignore
+drwxrwxr-x 2 user user 4096 .sourcekit-lsp
+-rw-rw-r-- 1 user user 463 Package.swift
+drwxrwxr-x 3 user user 4096 Sources
+drwxrwxr-x 4 user user 4096 supersign
+-rw-rw-r-- 1 user user 39 supersign.yml
+
+Hello$ cat supersign.yml
+version: 1
+bundleID: com.example.Hello
+
+Hello$ cat .sourcekit-lsp/config.json
+{ "swiftPM": { "swiftSDK": "arm64-apple-ios" } }
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app.md b/Sources/SupersignCLI/Documentation.docc/First-app.md
deleted file mode 100644
index 62d7881..0000000
--- a/Sources/SupersignCLI/Documentation.docc/First-app.md
+++ /dev/null
@@ -1,141 +0,0 @@
-# Build Your First iOS App on Linux
-
-Use Supersign to build and deploy an iOS app from your Linux machine.
-
-## Prerequisites
-
-First, make sure you've set up Supersign. Follow the steps in <doc:Installation-Linux> or <doc:Installation-macOS>.
-
-## Overview
-
-Once you've set up Supersign, you can use it to build, package, and install iOS apps from either Linux or macOS.
-
-When building an iOS app on Linux, Supersign instructs SwiftPM to use the [Swift SDK for Cross Compilation](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) that we built during the setup process; specifically, `arm64-apple-ios` from `darwin.artifactbundle`. This SDK contains the necessary modules for building iOS apps, such as UIKit and SwiftUI, as well as tools for building and manipulating iOS binaries. Swift SDKs are quite powerful, and you may want to check out the documentation to better understand how they work.
-
-## Steps
-
-### 1. Create an iOS-capable Swift Package
-
-Supersign comes with a template for iOS-capable Swift Packages. To create a new package, run
-
-```bash
-supersign dev new Hello
-# Creating package: Hello
-# Creating Package.swift
-# Creating supersign.yml
-# Creating .gitignore
-# Creating .sourcekit-lsp/config.json
-# Creating Sources/Hello/HelloApp.swift
-# Creating Sources/Hello/ContentView.swift
-#
-# Finished generating project Hello.
-
-cd Hello
-```
-
-At this point, feel free to poke around. The package is structured just like a regular SwiftPM library, with the addition of two files:
-
-- `supersign.yml`: This file describes how to bundle the Swift library into an iOS app. At minimum, you need to provide a Bundle ID. This defaults to `com.example.<PackageName>`, in this case `com.example.Hello`.
-- `.sourcekit-lsp/config.json`: This file tells SourceKit to use the `arm64-apple-ios` Swift SDK. This allows IDEs like Visual Studio Code to understand how the package is built, and provide contextual IntelliSense/autocomplete suggestions related to iOS.
-
-## 2. Build and install the app
-
-From inside the package directory, run
-
-```bash
-supersign dev
-# Planning...
-# Building for debugging...
-# [8/8] Linking Hello-App
-# Build of product 'Hello-App' complete! (4.94s)
-```
-
-The first time you run this, SwiftPM might take a few minutes to build the app. This is because it needs to build the Swift Modules for the iOS SDK. Subsequent runs should be a lot faster since SwiftPM caches these modules globally.
-
-After the build is complete, Supersign will attempt to install it on your device. You should see a line like
-
-```bash
-# Waiting for device to be connected...
-```
-
-At this point, connect your iOS device to your computer via USB. If you installed `libimobiledevice-utils` during setup, you can verify that your device is connected by running `ideviceinfo`. Supersign will continue after automatically detecting that your device is connected.
-
-> Pairing:
->
-> The first time you run `supersign dev`, you may see a "Trust" dialog on your iOS device to proceed with pairing. Tap **Trust** and enter your passcode on iOS. Supersign may throw an error after this: if so, just run `supersign dev` again.
-
-Supersign will now connect to Apple Developer Services, register your device with your Apple ID, generate a Certificate + App ID + Provisioning Profile, sign the app, and then install it.
-
-```bash
-# Installing to device: Kabir's iPhone (udid: *****)
-#
-# [Unpacking app] 100%
-# [Logging in] 100%
-# [Preparing device] 100%
-# [Provisioning] 100%
-# [Signing] 100%
-# [Packaging] 100%
-# [Connecting] 100%
-# [Installing] 100%
-# [Verifying] 100%
-```
-
-> Enable Development Mode:
->
-> At this point, you may run into an error asking you to enable **Development Mode** on your iOS device. Follow [these instructions](https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device) and then run `supersign dev` again.
-
-## 3. Run the app
-
-You should now see the app on your iOS device's home screen / App Library. Tap it to launch the app. You should see a "Hello World" message!
-
-> Trust Your Certificate:
->
-> The first time you launch the app, you might get an "Untrusted Developer" alert. To trust your developer identity, go to **Settings** > **General** > **VPN & Device Management** > _[your email]_ > **Trust**. You should now be able to launch the app.
-
-@Row(numberOfColumns: 2) {
- @Column {
- ![Hello world app](HelloWorld)
- }
-}
-
-## 4. Edit the app
-
-Open the project folder in your favorite IDE. As long as it supports Swift [via SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp/blob/242609dcad55824d9eb23269c0aeead187fd0faa/Documentation/Editor%20Integration.md), it should be able to understand your iOS project thanks to the `.sourcekit-lsp/config.json` file in the template.
-
-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).
-
-In `Sources/Hello/ContentView.swift`, let's update the "Hello, world!" text to be bold and purple:
-
-```diff
- import SwiftUI
-
- struct ContentView: View {
- var body: some View {
- VStack {
- Image(systemName: "globe")
- .imageScale(.large)
- .foregroundStyle(.tint)
- Text("Hello, world!")
-+ .bold()
-+ .foregroundStyle(.purple)
- }
- .padding()
- }
- }
-```
-
-While you do this, if you've correctly configured your editor with Swift support you should receive intelligent autocomplete suggestions.
-
-![Autocomplete](Autocomplete)
-
-## 5. Re-install the app
-
-Run `supersign dev` again to re-build and re-install. This should go a lot faster than the first time.
-
-Launch the app again to see the updated text!
-
-@Row(numberOfColumns: 2) {
- @Column {
- ![Modified hello world app](HelloWorld-Purple)
- }
-}
diff --git a/Sources/SupersignCLI/Documentation.docc/First-app.tutorial b/Sources/SupersignCLI/Documentation.docc/First-app.tutorial
new file mode 100644
index 0000000..a5515ac
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/First-app.tutorial
@@ -0,0 +1,161 @@
+@Tutorial(time: 30) {
+ @Intro(title: "Build Your First iOS App on Linux") {
+ Once you've completed <doc:Installation-Linux>, you can use Supersign to build and deploy an iOS app from your Linux machine.
+ }
+
+ @Section(title: "Create a Supersign project") {
+ We'll start by creating a project from Supersign's default template.
+
+ @Steps {
+ @Step {
+ Supersign comes with a template for iOS-capable Swift Packages. Run `supersign dev new` to create a new package.
+
+ @Code(name: "Terminal", file: "template-1b.sh", previousFile: "template-1a.sh") {}
+ }
+
+ @Step {
+ At this point, feel free to poke around.
+
+ Observe that the package is structured a lot like a regular SwiftPM library, with a few extra files.
+
+ @Code(name: "Terminal", file: "template-2b.sh", previousFile: "template-2a.sh") {}
+ }
+
+ @Step {
+ Read `supersign.yml`.
+
+ This file describes how to bundle the Swift library into an iOS app. At minimum, you need to provide a Bundle ID. This defaults to `com.example.<PackageName>`, in this case `com.example.Hello`.
+
+ @Code(name: "Terminal", file: "template-3b.sh", previousFile: "template-3a.sh") {}
+ }
+
+ @Step {
+ Read `.sourcekit-lsp/config.json`.
+
+ This file tells SourceKit to use the `arm64-apple-ios` Swift SDK. When building an iOS app on Linux, Supersign instructs SwiftPM to use the [Swift SDK for Cross Compilation](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) that we built during the setup process; specifically, `arm64-apple-ios` from `darwin.artifactbundle`. This SDK contains the necessary modules for building iOS apps, such as UIKit and SwiftUI, as well as tools for building and manipulating iOS binaries. Swift SDKs are quite powerful, and you may want to check out the documentation to better understand how they work.
+
+ @Code(name: "Terminal", file: "template-4b.sh", previousFile: "template-4a.sh") {}
+ }
+ }
+ }
+
+ @Section(title: "Build and run") {
+ Now that we have a skeleton project, let's get it running on your device.
+
+ @Steps {
+ @Step {
+ From inside the package directory, run `supersign dev`.
+
+ The first time you run this, SwiftPM might take a few minutes to build the app. This is because it needs to build the Swift Modules for the iOS SDK. Subsequent runs should be a lot faster since SwiftPM caches these modules globally.
+
+ @Code(name: "Terminal", file: "build-1b.sh", previousFile: "build-1a.sh")
+ }
+
+ @Step {
+ After the build is complete, Supersign will attempt to install it on your device.
+
+ At this point, connect your iOS device to your computer via USB. If you installed `libimobiledevice-utils` during setup, you can verify that your device is connected by running `ideviceinfo`. Supersign will continue after automatically detecting that your device is connected.
+
+ @Code(name: "Terminal", file: "build-2.sh", reset: true)
+ }
+
+ @Step {
+ Pair your device if prompted.
+
+ The first time you run `supersign dev`, you may see a "Trust" dialog on your iOS device to proceed with pairing. Tap **Trust** and enter your passcode on iOS. Supersign may throw an error after this: if so, just run `supersign dev` again.
+
+ @Code(name: "Terminal", file: "build-2.sh", reset: true) {
+ @Image(source: "Trust", alt: "Prompt alerting user to trust device")
+ }
+ }
+
+ @Step {
+ Supersign will now connect to Apple Developer Services, register your device with your Apple ID, generate a Certificate + App ID + Provisioning Profile, sign the app, and then install it.
+
+ @Code(name: "Terminal", file: "build-3.sh", reset: true) {}
+ }
+
+ @Step {
+ Enable Developer Mode if needed.
+
+ At this point, you may run into an error asking you to enable **Development Mode** on your iOS device. Follow [these instructions](https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device) and then run `supersign dev` again.
+
+ @Code(name: "Terminal", file: "build-3.sh", reset: true) {
+ @Image(source: "Developer", alt: "Developer mode in Settings")
+ }
+ }
+
+ @Step {
+ You should now see the app on your iOS device's home screen / App Library. Tap it to launch the app.
+
+ @Image(source: "Home", alt: "Hello app on the home screen")
+ }
+
+ @Step {
+ The first time you launch the app, observe that you may get an "Untrusted Developer" alert.
+
+ @Image(source: "UntrustedDev", alt: "Alert prompting user to trust certificate")
+ }
+
+ @Step {
+ Go to **Settings** > **General** > **VPN & Device Management** > _[your email]_ > **Trust**.
+
+ @Image(source: "Verified", alt: "Trust settings")
+ }
+
+ @Step {
+ You should now be able to launch the app!
+
+ @Image(source: "HelloWorld", alt: "Hello world app")
+ }
+ }
+ }
+
+ @Section(title: "Edit and re-run") {
+ We'll make a small change to the app in your favorite code editor, and then re-run it.
+
+ @Steps {
+ @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).
+
+ @Image(source: "SwiftExtension", alt: "Swift extension for VSCode")
+ }
+
+ @Step {
+ Open the project folder in your editor, and drill down to `Sources/Hello/ContentView.swift`.
+
+ @Code(name: "ContentView.swift", file: "edit-2.swift") {}
+ }
+
+ @Step {
+ If you've configured SourceKit-LSP correctly, you should see rich documentation when you hover over the various types and methods.
+
+ @Code(name: "ContentView.swift", file: "edit-2.swift") {
+ @Image(source: "Hover", alt: "Intellisense")
+ }
+ }
+
+ @Step {
+ Let's update the "Hello, world!" text to be bold and purple.
+
+ @Code(name: "ContentView.swift", file: "edit-4.swift") {}
+ }
+
+ @Step {
+ Run `supersign dev` again to re-build and re-install. This should go a lot faster than the first time.
+
+ @Code(name: "Terminal", file: "rerun-5b.sh", previousFile: "rerun-5a.sh") {}
+ }
+
+ @Step {
+ Launch the app again to see the updated text!
+
+ @Code(name: "Terminal", file: "rerun-6.sh") {
+ @Image(source: "HelloWorld-Purple", alt: "Updated Hello app")
+ }
+ }
+ }
+ }
+}
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/Developer.PNG b/Sources/SupersignCLI/Documentation.docc/Resources/Developer.PNG
new file mode 100644
index 0000000..9028746
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/Developer.PNG differ
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/Home.png b/Sources/SupersignCLI/Documentation.docc/Resources/Home.png
new file mode 100644
index 0000000..15c21b4
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/Home.png differ
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/Hover.png b/Sources/SupersignCLI/Documentation.docc/Resources/Hover.png
new file mode 100644
index 0000000..4307fba
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/Hover.png differ
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/Hover2.png b/Sources/SupersignCLI/Documentation.docc/Resources/Hover2.png
new file mode 100644
index 0000000..d1b8797
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/Hover2.png differ
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/SwiftExtension.png b/Sources/SupersignCLI/Documentation.docc/Resources/SwiftExtension.png
new file mode 100644
index 0000000..af0c45d
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/SwiftExtension.png differ
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/Trust.png b/Sources/SupersignCLI/Documentation.docc/Resources/Trust.png
new file mode 100644
index 0000000..0992ca4
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/Trust.png differ
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/UntrustedDev.png b/Sources/SupersignCLI/Documentation.docc/Resources/UntrustedDev.png
new file mode 100644
index 0000000..71846ac
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/UntrustedDev.png differ
diff --git a/Sources/SupersignCLI/Documentation.docc/Resources/Verified.png b/Sources/SupersignCLI/Documentation.docc/Resources/Verified.png
new file mode 100644
index 0000000..dcd1bc9
Binary files /dev/null and b/Sources/SupersignCLI/Documentation.docc/Resources/Verified.png differ
diff --git a/Sources/SupersignCLI/Documentation.docc/ToC.tutorial b/Sources/SupersignCLI/Documentation.docc/ToC.tutorial
new file mode 100644
index 0000000..24eea8b
--- /dev/null
+++ b/Sources/SupersignCLI/Documentation.docc/ToC.tutorial
@@ -0,0 +1,11 @@
+@Tutorials(name: "Tutorials") {
+ @Intro(title: "Tutorials") {
+ Install Supersign and build your first iOS app on Linux.
+ }
+
+ @Chapter(name: "Getting Started") {
+ @Image(source: "HelloWorld", alt: "Getting Started")
+
+ @TutorialReference(tutorial: "doc:First-app")
+ }
+}