From ae9fbf2f3a242506d79a49776f578f055a9ebf3c Mon Sep 17 00:00:00 2001 From: kabiroberai Date: Fri, 3 Sep 2021 16:11:03 +0530 Subject: [PATCH] Add setup instructions to docs --- Guides/Getting Started.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Guides/Getting Started.md b/Guides/Getting Started.md index fce0ca2..1459234 100644 --- a/Guides/Getting Started.md +++ b/Guides/Getting Started.md @@ -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 
<current directory> $ <command>
for all shell commands. User input will be in red. Some text may be truncated using [...]. +## 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.