Skip to content

Commit

Permalink
Add setup instructions to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kabiroberai committed Sep 3, 2021
1 parent 4a80d88 commit ae9fbf2
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions Guides/Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,19 @@ This guide will show you how to make a simple Orion tweak which… spices up tex

To follow along, you will require the following things:

- [Theos](https://github.com/theos/theos/wiki/Installation)
- A machine running macOS, Windows 10 with WSL, or Linux. If using WSL or Linux, it is recommended that you use the [official Swift toolchain](https://github.com/kabiroberai/swift-toolchain-linux).
- A jailbroken iOS device with Orion installed.
- [Theos](https://github.com/theos/theos/wiki/Installation) on a machine running macOS, Windows 10 with WSL, or Linux.
- A jailbroken iOS device.
- The target app (in this tutorial, VLC for iOS) installed on your iOS device.

Note that this guide will use the format <pre>&lt;current directory&gt; $ <span class="inp">&lt;command&gt;</span></pre> for all shell commands. User input will be in <code><span class="inp">red</span></code>. Some text may be truncated using <code><span class="trunc">[...]</span></code>.

## Setup

Orion is currently in beta, so you need to take a few additional steps to use it once Theos is installed:

1. Add Theos repo (https://repo.theos.dev/) to your jailbroken device's package manager, and install the Orion package (pick iOS 12-13 or iOS 14 depending on your version).
2. Inside your Theos installation directory (`$THEOS`), switch to the `orion` branch by running `git fetch && git checkout orion && git submodule update --init`.

## Initializing an Orion Tweak

Theos comes with a `tweak_swift` template which uses Orion.
Expand Down

0 comments on commit ae9fbf2

Please # to comment.