3-group-ios/GBA002
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[README] Updates compilation instructions

Browse Source 
* Adds instructions for updating Systems.xcworkspace
* Asks user to install Git LFS
This commit is contained in:
Riley Testut 2022-08-17 10:51:47 -05:00
parent b2ab33bcd1
commit ee536f9ce5
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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. 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 ## 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* 1. Clone this repository by running the following command in Terminal*
```bash ```bash
$ git clone https://github.com/rileytestut/Delta.git $ git clone https://github.com/rileytestut/Delta.git
@ -145,11 +148,14 @@ $ cd Delta
$ git submodule update --init --recursive $ git submodule update --init --recursive
``` ```
3. Open `Delta.xcworkspace` and select the Delta project in the project navigator. 3. Open `Systems/Systems.xcworkspace` and select the "Systems" project in the project navigator (a.k.a. the left sidebar).
4. Select "Delta" under targets, then click the `Signing & Capabilities` tab. 4. Select "Systems" under `Targets`, then click the `Signing & Capabilities` tab.
5. Change `Team` from `Yvette Testut` to your own account. 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`). 6. Close `Systems/Systems.xcworkspace`, then open `Delta.xcworkspace`.
7. Build + run app! 🎉 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: \* 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 ```bash