Skip to content

Commit 582b29a

Browse files
committed
Update README.md for multiple looper option
1 parent 864bebd commit 582b29a

File tree

1 file changed

+38
-12
lines changed

1 file changed

+38
-12
lines changed

README.md

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,34 @@ low alert for the BG you want to wake up to and close Loop.
4141

4242
Please see [Loop and Learn: Loop Follow](https://www.loopandlearn.org/loop-follow/) for all the building options.
4343

44+
With the release of version 2.1.0, there is now an easy option for building up to three instances of the Loop Follow app for multiple Loopers in your family. Each instance can be configured to have the display name you choose with these names being the default:
45+
46+
* LoopFollow
47+
* LoopFollow_Second
48+
* LoopFollow_Third
49+
50+
#### Display Name Updates
51+
52+
The _display_name_ is found in a single file.
53+
54+
* Suggestion if you customize the name: use LF {unique name} so you can find the apps easily in iOS Settings screen
55+
56+
Summary instructions by build method:
57+
58+
* Browser Build:
59+
* Commit the desired _display_name_ in the LoopFollowDisplayNameConfig.xcconfig file of your forked repository for LoopFollow, LoopFollow_Second or LoopFollow_Third
60+
* Mac-Xcode Build
61+
* First build with script, you will be prompted to enter the desired _display_name_
62+
* This _display_name_ is used each time you select a fresh download for LoopFollow 1, 2 or 3
63+
* To modify the _display_name_ for subsequent script builds, edit the appropriate file in the ~/Downloads/BuildLoopFollow folder
64+
* LoopFollowDisplayNameConfig.xcconfig
65+
* LoopFollowDisplayNameConfig_Second.xcconfig
66+
* LoopFollowDisplayNameConfig_Third.xcconfig
67+
68+
#### Updates
69+
70+
When modifications and versions are updated, there might be a slight delay for getting the second and third forks updated as well, so if you are using this feature, wait until all three repositories are updated.
71+
4472
### General feature list
4573

4674
Please review the list on [Loop and Learn: Loop Follow](https://www.loopandlearn.org/loop-follow/) which may be updated more frequently than this README.md file.
@@ -67,7 +95,7 @@ Please review the list on [Loop and Learn: Loop Follow](https://www.loopandlearn
6795
6896
### Versions
6997

70-
We added version numbers that are incremented with each pull request that is merged.
98+
We added version numbers that are incremented with each pull request (or group of pull requests) merged.
7199

72100
New PR are directed to the dev branch. If you direct one to main, we will move it to point to dev. So always start with your code aligned with dev.
73101

@@ -76,28 +104,26 @@ The versioning is:
76104
* major.minor.micro
77105
* For example our first version is 2.0.0
78106

79-
After that we made a decision to make the micro numbering be 2 digits.
80-
81-
After a PR is merged to dev, the repository maintainers will bump up the micro verion number - please do not modify the version in your branch.
107+
After a PR is merged to dev, the repository maintainers will bump up the verion number before merging to main - please do not modify the version in your branch.
82108

83109
For the most part, the deveopers keep main and dev branches at the same level. But sometimes we want modification to remain in dev for additional testing.
84110

85111
#### Version Example
86112

87-
Starting with version 2.0.01
113+
Starting with version 2.1.0
88114

89115
* PR with Feature A gets merged to dev
90-
* Maintainers, bump dev to 2.0.02
116+
* Maintainers, bump dev to 2.1.0
91117
* Maintainers merge dev into main
92-
* both main and dev are at 2.0.02
118+
* both main and dev are at 2.1.0
93119
* PR with Feature B gets merged to dev
94-
* Maintainers, bump dev to 2.0.03
95-
* main is still at 2.0.02
120+
* Maintainers, bump dev to 2.1.1
121+
* main is still at 2.1.0
96122
* PR with Feature C gets merged to dev
97-
* Maintainers, bump dev to 2.0.04
98-
* main is still at 2.0.02
123+
* Maintainers, bump dev to 2.1.2
124+
* main is still at 2.1.0
99125
* Maintainers merge dev into main
100-
* both main and dev are at 2.0.04
126+
* both main and dev are at 2.1.2
101127

102128
#### Version Updates
103129

0 commit comments

Comments
 (0)