Skip to content

Commit

Permalink
[README] Updates compilation instructions
Browse files Browse the repository at this point in the history
* Adds instructions for updating Systems.xcworkspace
* Asks user to install Git LFS
  • Loading branch information
rileytestut committed Aug 16, 2022
1 parent 9e14692 commit 07c1703
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ Each system in Delta is implemented as its own "Delta Core", which serves as a s
Why iOS 12.2 or later? Doing so allows me to distribute Delta without embedding Swift libraries inside. This helps me afford bandwidth costs by reducing download sizes by roughly 30%, but also noticeably improves how long it takes to install/refresh Delta with AltStore. If you're compiling Delta yourself, however, you should be able to lower the deployment target to iOS 12.0 without any issues.

## Compilation Instructions

> Delta uses Git LFS to manage large files, so first make sure you have [installed Git LFS](https://git-lfs.github.com).
1. Clone this repository by running the following command in Terminal*
```bash
$ git clone https://github.com/rileytestut/Delta.git
Expand All @@ -145,11 +148,14 @@ $ cd Delta
$ git submodule update --init --recursive
```

3. Open `Delta.xcworkspace` and select the Delta project in the project navigator.
4. Select "Delta" under targets, then click the `Signing & Capabilities` tab.
5. Change `Team` from `Yvette Testut` to your own account.
6. Change `Bundle Identifier` to something unique, such as by appending your GitHub username (ex: `com.rileytestut.Delta.MyGitHubUsername`).
7. Build + run app! 🎉
3. Open `Systems/Systems.xcworkspace` and select the "Systems" project in the project navigator (a.k.a. the left sidebar).
4. Select "Systems" under `Targets`, then click the `Signing & Capabilities` tab.
5. Change `Team` from "Yvette Testut" to your own account.
6. Close `Systems/Systems.xcworkspace`, then open `Delta.xcworkspace`.
6. Repeat steps 4 & 5 with the "Delta" target.
7. Change Delta's `Bundle Identifier` to something unique, such as by appending your GitHub username (ex: `com.rileytestut.Delta.MyGitHubUsername`).
8. Build + run app! 🎉


\* This will checkout the `main` branch by default, which is kept up-to-date with the latest public version. Ongoing development (including [Patreon betas](https://www.patreon.com/rileytestut)) is done on the `develop` branch, and is periodically merged into `main` whenever a new public version is released. If you'd prefer to compile the `develop` version instead, replace the `git clone` command in Step #1 with this one:
```bash
Expand Down

0 comments on commit 07c1703

Please sign in to comment.