Skip to content

Commit

Permalink
Merge pull request #864 from marionbarker/working-docs
Browse files Browse the repository at this point in the history
Updates related to iOS 18 release
  • Loading branch information
marionbarker authored Sep 19, 2024
2 parents a45ed1e + a7f9447 commit fbb0250
Show file tree
Hide file tree
Showing 8 changed files with 2,054 additions and 4,303 deletions.
16 changes: 10 additions & 6 deletions docs/browser/bb-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

**This page is only relevant when building with a browser.**

**For *Mac*, please see: [Update/Rebuild with *Mac*](../build/updating.md)**
**For *Mac*, please see: [Update/Rebuild with *Mac*](../build/updating.md){: target="_blank" }**

> Regardless of build method, this is an **update** and will install over your existing app; your **settings are maintained including your current CGM and Pump.**
???+ info "Time Estimate (click to open/close)"
Build the *Loop* App
Expand Down Expand Up @@ -54,7 +56,7 @@

Under ordinary circumstances, you do not *have to* rebuild or update your *Loop* app until *TestFlight* forces you to (90 days). However, there is no harm in building more frequently.

* You control when the new app is installed on your phone, refer to: [Install on Phone: Disable Automatic Install from *TestFlight*](phone-install.md#disable-automatic-install-from-testflight)
* You control when the new app is installed on your phone, refer to: [Install on Phone: Disable Automatic Install from *TestFlight*](phone-install.md#disable-automatic-install-from-testflight){: target="_blank" }
* You always want a build available in the *TestFlight* app
* You can use *TestFlight* to quickly install the app if you loose or break your phone and need to replace it
* You can use *TestFlight* to quickly install the app if someone accidentally deletes the app from your phone
Expand Down Expand Up @@ -177,19 +179,21 @@ Open your *GitHub* account and select your <code>LoopWorkspace repository</code>

### Up to Date or Behind

* If your `fork` is up to date with LoopKit version, you will see the message `This branch is up to date with LoopKit/LoopWorkspace:{branch}` - there is no need to build again unless your Loop app in *TestFlight* is about to expire - in which case, proceed to [Build the *Loop* App](#build-the-loop-app)
The bullets below show typical messages when you are building the `main` branch. If you are building a different `branch`, the messages show that `branch name` instead of `main`.

* If your `fork` is up to date with LoopKit, you will see the message `This branch is up to date with LoopKit/LoopWorkspace:main` - there is no need to build again unless your Loop app in *TestFlight* is about to expire - in which case, proceed to [Build the *Loop* App](#build-the-loop-app)

* If your `fork` shows a message such as `This branch is 3 commits behind LoopKit:main` and you want to update and build, then click `Sync Fork` by tapping where the red rectangle is shown in the graphic below, then in the pop-up window, tap on `Update branch` and if it succeeds, move on to [Build the *Loop* App](#build-the-loop-app)
* If your `fork` shows a message such as `This branch is 2 commits behind LoopKit/LoopWorkspace:main` and you want to update and build, then click `Sync Fork` by tapping where the red rectangle is shown in the graphic below, then in the pop-up window, tap on `Update branch` and if it succeeds, move on to [Build the *Loop* App](#build-the-loop-app)

![message displayed when your fork of LoopWorkspace is behind LoopKit version](img/github-build-check-fork-status.svg){width="700"}
{align="center"}

### Ahead and Behind

* If your `fork` shows a message such as `This branch is 3 commits behind LoopKit:main and 4 commits ahead of LoopKit:main`; you might need to manually resolve a conflict.
* If your `fork` shows a message such as `This branch is 2 commits ahead, 16 commits behind LoopKit/LoopWorkspace:main`; you might need to manually resolve a conflict.
* This can happen if you customized your build
* Sometimes GitHub lets you keep your customizations while updating the `fork`
* The GIF below is an example for LoopFollow
* The GIF below is an example for the **LoopFollow** app
* Frame 1 shows the repository is both ahead and behind
* Frame 2 shows the `Sync Fork` option was selected
* Frame 3 shows that GitHub was able to merge the new branch with existing customization
Expand Down
3,016 changes: 453 additions & 2,563 deletions docs/browser/img/github-build-check-fork-status.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/build/build-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ If you are running iOS 15/watchOS 8, you do not have <code>Developer Mode</code>

### Upgrade from iOS 15 to newer version

**If you upgrade an iOS 15 phone to iOS 16 or 17, the *Loop* app will not open until you enable <code>Developer Mode</code> on that phone.**
**If you upgrade an iOS 15 phone to iOS 16 or newer, the *Loop* app will not open until you enable <code>Developer Mode</code> on that phone.**

You will see a message similar to the next graphic.

![phone message if trying to run xcode app without developer mode enabled](img/phone-developer-mode-required.jpeg){width="300"}
{align="center"}

If you are running iOS 16 or 17 with watchOS 9 or newer, you must enable <code>Developer Mode</code> to run or build Loop directly from Xcode. (This is true for any app created by Xcode directly on your device.) If you want to know more, click on this [Apple Link about <code>Developer Mode</code>](https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device){: target="_blank" }.
If you are running iOS 16 or newer with watchOS 9 or newer, you must enable <code>Developer Mode</code> to run or build Loop directly from Xcode. (This is true for any app created by Xcode directly on your device.) If you want to know more, click on this [Apple Link about <code>Developer Mode</code>](https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device){: target="_blank" }.

### Prepare your Phone and Watch

Expand Down Expand Up @@ -332,7 +332,7 @@ The first time you build, there will be steps that will not be required for subs
3. Running
* Wait for app to open on your phone

With iOS 17, it takes longer for the app to open on your phone after you see the "Running" message than with earlier iOS versions. Wait for it.
With *iOS* 17 and newer, it takes longer for the app to open on your phone after you see the "Running" message than with earlier iOS versions. Wait for it.

Refer to the GIF below:

Expand Down
34 changes: 27 additions & 7 deletions docs/build/computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@

!!! tip "Build with Browser"

If you do not have a Mac, you can build&nbsp;<span translate="no">Loop 3</span>&nbsp;with any computer using a browser. If you want to use that method, review this list and head over to [Build with Browser](../browser/bb-overview.md).
If you do not have a Mac, you can build&nbsp;<span translate="no">Loop 3</span>&nbsp;with any computer using a browser. If you want to use that method, review this list and head over to [Build with Browser](../browser/bb-overview.md){: target="_blank" }.

- You need a paid ($99/year)&nbsp;[<span translate="no">Apple Developer Account</span>](apple-developer.md)
- You need a paid ($99/year)&nbsp;[<span translate="no">Apple Developer Account</span>](apple-developer.md){: target="_blank" }
- You need an account (free) with&nbsp;[<span translate="no">GitHub</span>](https://github.com){: target="_blank" }
- You need a [compatible phone](phone.md) to install the app from *TestFlight*
- You need a [compatible Pump](pump.md) and [CGM](cgm.md) if you want to actually use the app (and not just explore the app)
Expand All @@ -26,8 +26,8 @@


!!! question "FAQs"
- **"Do I need a Mac or Virtual Machine?."** Not any more! You can build [Loop 3](../browser/bb-overview.md) with any browser on any computer.
- **"I want to use the build with *Mac* method. Can I use a PC or Windows computer? I don't own an Apple computer."** Yes, you can but only if your PC uses Intel chips. Please read this FAQ about using a [Virtual Machine](../faqs/loop-faqs.md#can-i-use-a-pc-or-windows-computer-to-build).
- **"Do I need a Mac or Virtual Machine?."** Not any more! You can build [Loop 3](../browser/bb-overview.md){: target="_blank" } with any browser on any computer.
- **"I want to use the build with *Mac* method. Can I use a PC or Windows computer? I don't own an Apple computer."** Yes, you can but only if your PC uses Intel chips. Please read this FAQ about using a [Virtual Machine](../faqs/loop-faqs.md#can-i-use-a-pc-or-windows-computer-to-build){: target="_blank" }.
- **"How often do I need to use the computer if I choose the build with *Mac* method?"** Computer access is required when
* Initially installing the Loop app
* Loop app expires (Annually for a paid account or weekly for a free account)
Expand All @@ -38,16 +38,23 @@ If you have access to a computer with MacOS 14.0 or newer, you can skip ahead to

## Compatible Versions

The current release of&nbsp;_<span translate="no">Loop</span>_&nbsp; requires Xcode version 15 or higher regardless of the iOS on the phone. This requires macOS 13.5 or higher. If your phone is iOS 17.4 or newer, you must have macOS 14.0 or higher. As an alternative, use [Build with Browser](../browser/bb-overview.md), which supports iOS 15, 16, and 17.
The current release of&nbsp;_<span translate="no">Loop</span>_&nbsp; requires Xcode version 15 or higher regardless of the iOS on the phone. This requires macOS 13.5 or higher.

When this page was last updated, macOS 14.6 and Xcode 15.4 were tested to successfully build the app for phones with iOS 15 through iOS 17.6.1.
* If your phone is iOS 17.4 or newer, you must have macOS 14.0 or higher.
* If your phone is iOS 18.0 or newer, you must have macOS 14.5 or higher.
* As an alternative, use [Build with Browser](../browser/bb-overview.md){: target="_blank" }, which supports iOS 15, 16, 17 and 18.

When this page was last updated, macOS 14.6 and Xcode 15.4 were tested to successfully build the app for phones with iOS 15 through iOS 18.0.

> Until a fix is applied, building with macOS 14.6 (or 15.0) using Xcode 16 builds Loop but the provisioning profile (expiration) date is not yet captured.
The table below lists the **minimum** requirements to build the current release of&nbsp;<span translate="no">Loop 3.4.1</span>. If your macOS or Xcode version is higher, you can build with *Mac*.

Find your phone iOS in the table below. If your iOS is not listed, e.g., 17.6.1, choose the first row that is less than your iOS.

| iOS Version | minimum Xcode | minimum macOS |
|:---:|:---:|:---:|
| 18.0 | 15.4 | 14.5 |
| 17.5 | 15.4 | 14.0 |
| 17.4 | 15.3 | 14.0 |
| 15.1 to<br>17.0 | 15.0 | 13.5 |
Expand Down Expand Up @@ -86,6 +93,19 @@ You need to have 50 GB free space in order to install Xcode as directed on the [

If you are evaluating a used computer, it's best to have at least 256 GB total disk space (more is better).

## Which Macs Are Compatible with macOS Sequoia?

Sequoia is not yet required for building the *Loop* app on a phone running iOS 18 or higher with the *Mac* method. The normal *Apple* schedule is that you will be required to have this installed by April of the year after the *iOS* version increments. The only difference between this list and the one for Sonoma is the MacBook Air must be newer for Sequoia.

* MacBook Pro introduced in 2018 or later
* MacBook Air introduced in 2020 or later
* Mac mini introduced in 2018 or later
* iMac introduced in late 2019 or later
* iMac Pro introduced in 2017 or later
* Mac Studio introduced in 2022 or later
* Mac Pro introduced in 2019 or later
* get the full list from [Apple for Sequoia](https://support.apple.com/en-us/120282){: target="_blank" }

## Which Macs Are Compatible with macOS Sonoma?

Sonoma is required for building the *Loop* app on a phone running iOS 17.4 or higher with the *Mac* method. You can install Sonoma on the following:
Expand All @@ -101,7 +121,7 @@ Sonoma is required for building the *Loop* app on a phone running iOS 17.4 or hi

## Older Macs

Look into building with [GitHub Actions](../browser/bb-overview.md) - no need to worry about versions for Mac OS or Xcode - all done for you on GitHub (some configuration required). Works with any computer (PC or Mac or Tablet).
Look into building with [GitHub Actions](../browser/bb-overview.md){: target="_blank" } - no need to worry about versions for Mac OS or Xcode - all done for you on GitHub (some configuration required). Works with any computer (PC or Mac or Tablet).

## Next Step:

Expand Down
Loading

0 comments on commit fbb0250

Please sign in to comment.