Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md to update submodules when cloning the repository #289

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md to update submodules when cloning the repository #289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6839808
Update README.md
notraceofsense Feb 28, 2024
5b00ed2
Update README.md
notraceofsense Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 7 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,29 +135,23 @@ Each system in Delta is implemented as its own "Delta Core", which serves as a s

> 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 and update Git submodules by running the following command in Terminal*
```bash
$ git clone https://github.com/rileytestut/Delta.git
$ git clone --recurse-submodules https://github.com/rileytestut/Delta.git
```

2. Update Git submodules
```bash
$ cd Delta
$ git submodule update --init --recursive
```

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`.
2. Open `Systems/Systems.xcworkspace` and select the "Systems" project in the project navigator (a.k.a. the left sidebar).
3. Select "Systems" under `Targets`, then click the `Signing & Capabilities` tab.
4. Change `Team` from "Yvette Testut" to your own account.
5. 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
$ git clone -b develop https://github.com/rileytestut/Delta.git
$ git clone --recurse-submodules -b develop https://github.com/rileytestut/Delta.git
```

## Licensing
Expand Down