You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -3602,6 +3572,9 @@ <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Anchor l
3602
3572
<li><strong><ahref="../../version/development/#whats-going-on-in-the-dev-branch">What's going on in the <code>dev branch</code></a></strong></li>
3603
3573
</ul>
3604
3574
<h2id="buildloopdev-script"><code>BuildLoopDev</code> Script<aclass="headerlink" href="#buildloopdev-script" title="Anchor link to this Header on this Page">¶</a></h2>
3575
+
<blockquote>
3576
+
<p>Choose the tip of dev when using the existing scripts. The concept of the lightly tested <abbrtitle="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr> is no longer needed. Each <code>dev</code> update comes with a new dev version number after a formal review process.</p>
3577
+
</blockquote>
3605
3578
<p>There is a script to assist in building the <code>dev branch</code>. It gives you the option to choose the tip of the <code>dev branch</code> or to build a lightly tested <abbrtitle="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr>. If you have not used the <ahref="../build-app/#build-select-script"><abbrtitle="by running a command in your terminal, this menu-driven tool assists in building Loop">Build Select Script</abbr></a> to build <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> previously, you may want to review that page. The command below can be pasted into the terminal of your Mac. Read the directions in the script.</p>
3606
3579
<divclass="copy highlight"><spanclass="filename">Copy and Paste to start the BuildLoopDev script</span><pre><span></span><code>/bin/bash<spanclass="w"></span>-c<spanclass="w"></span><spanclass="s2">"</span><spanclass="k">$(</span>curl<spanclass="w"></span>-fsSL<spanclass="w"></span><spanclass="se">\</span>
@@ -3622,14 +3595,16 @@ <h2 id="update-loop-dev">Update <abbr title="With a capital L, Loop is one of se
3622
3595
<li>Some are comfortable with the command line <abbrtitle="a tool for version control">git</abbr> commands described on <ahref="../../version/loopworkspace/#updating-loop-using-loopworkspace">here</a>.</li>
3623
3596
</ul>
3624
3597
<h2id="loop-dev-version"><abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>-dev Version<aclass="headerlink" href="#loop-dev-version" title="Anchor link to this Header on this Page">¶</a></h2>
3625
-
<p>The version of code that shows up under the <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Settings screen does not change when the <code>dev branch</code> is modified.</p>
3626
-
<p>If you need help with your app, the mentors need more information. Please issue a <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Report when asking for help. Refer to <ahref="../../loop-3/settings/#support">Support</a> for how to issue a <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Report. If you want to keep track yourself, refer to <ahref="#identify-loop-dev-version">Identify <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>-dev Version</a></p>
3598
+
<p>Starting with v3.7.x, the version of code that shows up under the <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Settings screen increments with each formal change to the <code>dev</code><abbrtitle="version of code within a single repository or workspace repository">branch</abbr> using the pull request process. That increment might be an update to match a hotfix to <code>main</code> or might be from a new feature brought just into the <code>dev</code><abbrtitle="version of code within a single repository or workspace repository">branch</abbr>.</p>
3599
+
<p>If you need help with your app, the mentors need to know you are running a <code>dev</code><abbrtitle="version of code within a single repository or workspace repository">branch</abbr> and the specific version that shows on your settings screen. </p>
3600
+
<p>For a summary of features added to the <code>dev</code><abbrtitle="version of code within a single repository or workspace repository">branch</abbr> by version number:</p>
3601
+
<ul>
3602
+
<li><ahref="../../version/development/#updates-in-dev" target="_blank">Updates in <code>dev</code></a></li>
3603
+
</ul>
3604
+
<p>For more information about version numbers:</p>
3627
3605
<ul>
3628
-
<li><ahref="../../version/releases/#loop-version-numbering"><code>Loop</code> Version Numbering</a></li>
3606
+
<li><ahref="../../version/releases/#loop-version-numbering"target="_blank"><code>Loop</code> Version Numbering</a></li>
3629
3607
</ul>
3630
-
<h3id="identify-loop-dev-version">Identify <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>-dev Version<aclass="headerlink" href="#identify-loop-dev-version" title="Anchor link to this Header on this Page">¶</a></h3>
3631
-
<p>The version of code that shows up under the <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Settings screen will remain fixed until <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>-dev is released. In order to identify which version of dev you have on your phone, you need the <abbrtitle="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr>.</p>
3632
-
<p>The <abbrtitle="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr> is identified by a 7-digit alphanumeric code. That code was also appended to the folder name of the downloaded code under Downloads/BuildLoop as shown in the graphic above. You can use finder to view the folder name after the script completes. It also appears in the <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Report, refer to <ahref="../../loop-3/settings/#support">Support</a> for instructions on issuing a <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Report. After you issue the <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> Report, look at the workspaceGitRevision number near the beginning of the report.</p>
<h2id="screenshots">Screenshots<aclass="headerlink" href="#screenshots" title="Anchor link to this Header on this Page">¶</a></h2>
3718
-
<p>Please take screenshots of your issue and include them in your posts. On an Apple computer, press <spanclass="keys"><kbdclass="key-shift">Shift</kbd><span>+</span><kbdclass="key-command">Cmd</kbd><span>+</span><kbdclass="key-4">4</kbd></span> keys at the same time and a little crosshairs tool will appear. Click-and-drag across the area you'd like to include in the screenshot. When you let go of the button, the screenshot will be saved to your desktop with a file name starting with the name <code>Screen Shot</code>. To capture an entire window, press <spanclass="keys"><kbdclass="key-shift">Shift</kbd><span>+</span><kbdclass="key-command">Cmd</kbd><span>+</span><kbdclass="key-4">4</kbd></span> keys at the same time followed by pressing <spanclass="keys"><kbdclass="key-space">Space</kbd></span> (the space bar) and then click on the window of interest.</p>
3719
-
<p><strong>Use screenshots instead of cell phone images whenever possible.</strong> Screenshots are higher resolution and easier to read.</p>
3720
-
<p>Take a wide screenshot (full window capture) when asking for help with settings or <abbrtitle="program used to build an app">Xcode</abbr> build errors. <abbrtitle="a personal website used to view your glucose and diabetes management data, `Loop` can upload to `Nightscout`">Nightscout</abbr> and <abbrtitle="program used to build an app">Xcode</abbr> have lots of valuable information off-to-the-side that can be valuable for troubleshooters.</p>
3784
+
<p>Please take screenshots of your issue and include them in your posts - unless you want Browser Build help. <strong>For Browser Build, include your <abbrtitle="website address (Uniform Resource Locator)">URL</abbr>, not a screenshot.</strong></p>
3785
+
<h3id="help-with-the-app">Help with the app<aclass="headerlink" href="#help-with-the-app" title="Anchor link to this Header on this Page">¶</a></h3>
3786
+
<p>If you are asking for help using the <em><abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> app after you've already built it, take screenshots on your phone and upload to either Facebook or zulipchat along with your question.</p>
3787
+
<p>If you are posting <em><abbrtitle="a personal website used to view your glucose and diabetes management data, `Loop` can upload to `Nightscout`">Nightscout</abbr></em> graphics, use the full window from either your phone or your computer in your screenshot.</p>
3788
+
<blockquote>
3789
+
<p><ahref="../../intro/loopdocs-how-to/#how-to-find-help" target="_blank">How to Find Help</a></p>
3790
+
</blockquote>
3791
+
<h3id="help-with-browser-build">Help with Browser Build<aclass="headerlink" href="#help-with-browser-build" title="Anchor link to this Header on this Page">¶</a></h3>
3792
+
<p>If you need help with building the app using a browser, copy the <abbrtitle="website address (Uniform Resource Locator)">URL</abbr> for the LoopWorkspace <abbrtitle="a copy of code in a github repository other than the original">fork</abbr> and paste it into Facebook or zulipchat along with your question.</p>
3793
+
<blockquote>
3794
+
<p><ahref="../../intro/loopdocs-how-to/#how-to-find-help" target="_blank">How to Find Help</a></p>
3795
+
</blockquote>
3796
+
<h3id="help-with-mac-build">Help with Mac Build<aclass="headerlink" href="#help-with-mac-build" title="Anchor link to this Header on this Page">¶</a></h3>
3797
+
<p>If you are building with a Mac computer and need assistance, <strong>use screenshots</strong> from your Mac computer. Taking a cell phone photo of your Mac screen is generally insufficient.</p>
3798
+
<p>Include full window capture when asking for help. The <em><abbrtitle="a personal website used to view your glucose and diabetes management data, `Loop` can upload to `Nightscout`">Nightscout</abbr></em> and <em><abbrtitle="program used to build an app">Xcode</abbr></em> apps have lots of valuable information off-to-the-side that can be valuable for troubleshooters.</p>
3799
+
<blockquote>
3800
+
<p><ahref="../../intro/loopdocs-how-to/#how-to-find-help" target="_blank">How to Find Help</a></p>
3801
+
</blockquote>
3802
+
<h4id="how-to-obtain-a-screenshot-on-a-mac">How to Obtain a Screenshot on a Mac<aclass="headerlink" href="#how-to-obtain-a-screenshot-on-a-mac" title="Anchor link to this Header on this Page">¶</a></h4>
3803
+
<p>On an Apple computer, press <spanclass="keys"><kbdclass="key-shift">Shift</kbd><span>+</span><kbdclass="key-command">Cmd</kbd><span>+</span><kbdclass="key-4">4</kbd></span> keys at the same time and a little crosshairs tool will appear. Click-and-drag across the area you'd like to include in the screenshot. When you let go of the button, the screenshot will be saved to your desktop with a file name starting with the name <code>Screen Shot</code>. To capture an entire window, press <spanclass="keys"><kbdclass="key-shift">Shift</kbd><span>+</span><kbdclass="key-command">Cmd</kbd><span>+</span><kbdclass="key-4">4</kbd></span> keys at the same time followed by pressing <spanclass="keys"><kbdclass="key-space">Space</kbd></span> (the space bar) and then click on the window of interest.</p>
3721
3804
<h2id="descriptive-language">Descriptive Language<aclass="headerlink" href="#descriptive-language" title="Anchor link to this Header on this Page">¶</a></h2>
3722
3805
<p>Use descriptive language - the most accurate, detailed words possible - when asking for help. Try to avoid the word "it" and instead use details and information to explain why you're asking for help, what you've already tried, and what happened when you tried those things (including screenshots). Let's illustrate with a couple of examples.</p>
3723
3806
<h3id="example-1">Example 1<aclass="headerlink" href="#example-1" title="Anchor link to this Header on this Page">¶</a></h3>
<p>This example is not quite as old, but does refer to details from older <em><abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> and <em><abbrtitle="operating system used by Apple Mobile devices (iPhone, iPod, iPad)">iOS</abbr></em> versions. It exemplifies the details needed to assist someone with a build error.</p>
3732
3815
<divclass="admonition tip">
3733
3816
<pclass="admonition-title">Build with Browser</p>
3734
-
<p>If you are using the Build with Browser method, we still need descriptive details but we do not need screenshots. All that is required is to list your <em><abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> user name. The volunteers can then read your publicly available log files. (All private information is automatically redacted in those logs.)</p>
3817
+
<p>If you are using the Build with Browser method, we still need descriptive details but we do not need screenshots. All that is required is to list your <em><abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> user name. Of course it's really nice if you just paste in your <abbrtitle="website address (Uniform Resource Locator)">URL</abbr> - then we don't have to construct the link. The volunteers can then read your publicly available log files. (All private information is automatically redacted in those logs.)</p>
3735
3818
</div>
3736
3819
<p><strong>Bad:</strong> "<code>My Loop app won't build.</code>" <----- What step are you on? What is the <abbrtitle="operating system used by Apple Mobile devices (iPhone, iPod, iPad)">iOS</abbr> on your phone? What kind of computer are you using? What <abbrtitle="operating system for Mac computer">macOS</abbr>? What <abbrtitle="program used to build an app">Xcode</abbr> version? Have you built successfully before or is this new?</p>
3737
3820
<p><strong>Ok:</strong> "<code>I'm trying to update my Loop app and am getting a few errors that I don't understand.</code>" <----- Wow, sure would be nice to know what those error messages are. Are they red or yellow? A screenshot sure would help here.</p>
<h2id="be-ok-with-links">Be OK with Links<aclass="headerlink" href="#be-ok-with-links" title="Anchor link to this Header on this Page">¶</a></h2>
3741
3824
<p>Often, the best answer to your question is sending a link to the answer in <em>LoopDocs</em> or <em>LoopTips</em>. This provides you a quick, accurate and complete answer. We understand that there is so much information in these sites that it can be hard to find answers. Mentors know the docs well, are experts at using the search tools and will send direct links to the sections that best answer your question.</p>
3742
3825
<p>If you've searched the docs and read relevant info already, please include that in your post or your reply. That way you don't get linked back to the part you are confused about. And if you have already read the specific section a mentor just linked, be specific about why your problem is not addressed by that link. Or just say "I'm confused when the doc says this". Letting us know when these docs can be improved is very useful.</p>
3826
+
<hr/>
3743
3827
<h2id="next-step">Next Step<aclass="headerlink" href="#next-step" title="Anchor link to this Header on this Page">¶</a></h2>
3744
3828
<p>Now you are ready to build or continue with setting up the <em><abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> app.</p>
3745
3829
<h3id="return-to-set-up">Return to Set Up<aclass="headerlink" href="#return-to-set-up" title="Anchor link to this Header on this Page">¶</a></h3>
0 commit comments