Merge pull request #1 from loopandlearn/initial_version

Initial version

Author: marionbarker

.gitignore

@@ -0,0 +1,3 @@
+site
+.DS_Store
+/venv

docs/build/build-options.md

@@ -0,0 +1,84 @@
+## Building Options
+
+*LoopFollow* can be built using either the Browser Build or the Mac-Xcode Build method.  A paid Apple Developer account is required to use the Browser Build method.  Regardless of how you build, you can customize your *LoopFollow* app’s name.
+
+* Browser Build: See [LoopDocs: Browser Build for Other Apps]()
+* Mac-Xcode: [Build *LoopFollow* Script for Mac-Xcode](#build-loopfollow-script-for-mac-xcode)
+
+
+### Build LoopFollow Script for Mac-Xcode
+
+Carefully read the information in the terminal before making any choices.
+
+Step 1: Open Terminal
+
+> Tip: Press Command-Space to open spotlight search. Start typing “term” (without the quotes) and you will see the Terminal application icon in the box. Hit enter to open.
+
+Step 2: Copy the entire line starting with /bin/bash and then Paste the line into Terminal and enter
+
+Click on the copy icon at right of the box below to copy it. You’ll see Copied to Clipboard briefly.
+
+``` { .bash .copy title="Copy and Paste to start the Build LoopFollow Script" }
+/bin/bash -c "$(curl -fsSL \
+  https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoopFollow.sh)"
+```
+
+Step 3: Choose from one of the options presented by the script
+
+> If you are not following multiple Loopers, always choose 1 for the latest release.
+
+You are prompted to enter a custom name if you want or you can continue using the LoopFollow default name
+
+> If you are following up to 3 Loopers, choose option 1, 2 or 3.
+
+* Each Looper can have a unique name displayed for the app
+* Each time you download using the script, the name you selected the first time is remembered, but editing instructions are provided
+
+To test a specific feature that is only found in the dev branch, choose option 4. This is not typical, and only builds to the app associated with Looper #1
+
+### Run LoopFollow on Mac using TestFlight
+
+If you used the Browser Build method, follow these instructions to run LoopFollow on your Mac computer using TestFlight. (You can also use an iPad.)
+
+* You need to install the TestFlight app on your computer
+* The TestFlight app on the Mac shows the same set of builds and uses the same installation procedure as shown in LoopDocs for installing apps on a phone from TestFlight
+* Install on computer from TestFlight
+* You need to enter the data source and configuration values into the app on your computer
+
+From Mac system settings/notifications, scroll down to LoopFollow and enable notifications with the options you want.
+
+### Run LoopFollow on your Mac with Mac-Xcode Build
+
+1. Build LoopFollow to your Mac with Xcode (choose My Mac (Mac Catalyst) as the device)
+2. Click Stop to close the running app that is started by Xcode
+3. On the left side of Xcode, click on the Folder icon
+4. Click to open the LoopFollow folder list
+5. Click to open the LoopFollow/Products folder
+6. Right-click (or Control-click) on “LoopFollow.app” and select Show in Finder
+7. First time on the Mac:
+    * Drag the LoopFollow.app icon to your Applications folder in Finder
+    * From Mac system settings/notifications, scroll down to LoopFollow and enable notifications with the options you want
+8. When updating on your Mac
+    * Make sure you close the LoopFollow app currently running on your computer
+    * Drag the LoopFollow.app icon to your Applications folder in Finder
+    * Most people choose to replace the application, but you can keep both if you prefer
+    * All configurations and settings are maintained
+
+### Selection of Branch to Build
+
+`main` vs. `dev`
+
+*LoopFollow* users should build *LoopFollow*-main.  New features are tested in the dev branch. Once they are thoroughly tested, they are merged into main.  Experienced users can test *LoopFollow*-dev, but there will be minimal support. Any issues found with *LoopFollow*-dev should be reported in GitHub.   
+
+### Updates
+
+When modifications and versions are updated, you might see activity at GitHub. Please wait for the release message to be posted at [LoopFollow Releases](https://github.com/loopandlearn/LoopFollow/releases) before using the updated versions for the `main` branch of LoopFollow, LoopFollow_Second and LoopFollow_Third.
+
+### Version Numbers
+
+Updates to the `main` branch (releases) have a version number that ends in 0; for example, 3.1.0.
+
+* Immediately following the release, the `dev` branch is at the same version as `main` indicating the code is identical
+* Each time a feature is merged into the `dev` branch, the final number increments; for example, 3.1.1, 3.1.2
+* When the next release is made, the second digit is incremented and the final digit is restore to 0 for both `main` and `dev`; for example, 3.2.0
+

docs/faqs/glossary.md

@@ -0,0 +1,132 @@
+# Glossary
+
+Each item in the glossary is also a Tooltip. The word or phrase is repeated in parentheses to assist those using Google Translate.
+
+When Google Translate is selected:
+
+* Tooltips, indicated by dashed underline, continue to be shown in English
+* On the Glossary page
+    * The first instance (in bold) remains in English
+    * The second instance (in parentheses) is translated to your selected language
+
+**<span translate="no">API</span>**&nbsp; (API): Application Programming Interface
+
+**<span translate="no">APN</span>**&nbsp; (APN): Apple Push Notification service
+
+**<span translate="no">App Group</span>**&nbsp; (App Group): a unique identifier that Apple users for a given app, yours has your TEAMID embedded in it
+
+**<span translate="no">BLE</span>**&nbsp; (BLE): Bluetooth low energy, used for communication by phones, CGM and some pumps
+
+**<span translate="no">branch</span>**&nbsp; (branch): version of code within a single repository or workspace repository
+
+**<span translate="no">CAGE</span>**&nbsp; (CAGE): cannula (or pump site) age on Nightscout site
+
+**<span translate="no">Certificate</span>**&nbsp; (Certificate): Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID
+
+**<span translate="no">CGM</span>**&nbsp; (CGM): continuous glucose monitor, wearable medical device that measures and reports glucose in interstitial fluid
+
+**<span translate="no">clone</span>**&nbsp; (clone): create a copy of a repository on your computer including revision history and ability to update using git commands
+
+**<span translate="no">COB</span>**&nbsp; (COB): Carbs on Board, affects automated insulin delivery
+
+**<span translate="no">commit</span>**&nbsp; (commit): a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)
+
+**<span translate="no">Correction Factor</span>**&nbsp; (Correction Factor): how many points your blood sugar will drop for each unit of insulin
+
+**<span translate="no">CR</span>**&nbsp; (CR): Carb Ratio; how many grams of carbs are covered by one unit of rapid-acting insulin
+
+**<span translate="no">DIA</span>**&nbsp; (DIA): Duration of Insulin Action, the full time insulin is active including a long, low-level tail
+
+**<span translate="no">DIY</span>**&nbsp; (DIY): Do it yourself, a common acronym for the open-source software community (and the maker community)
+
+**<span translate="no">fork</span>**&nbsp; (fork): a copy of code in a github repository other than the original
+
+**<span translate="no">GIF</span>**&nbsp; (GIF): Graphics Interchange Format (GIF) can be used for small animations and low-resolution video clips
+
+**<span translate="no">git</span>**&nbsp; (git): a tool for version control
+
+**<span translate="no">GitHub</span>**&nbsp; (GitHub): an online service for storing repositories, accessible from a browser
+
+**<span translate="no">github.com</span>**&nbsp; (github.com): an online service for storing repositories, accessible from a browser
+
+**<span translate="no">Glucose Chart</span>**&nbsp; (Glucose Chart): Display of measured and predicted glucose values
+
+**<span translate="no">GMT</span>**&nbsp; (GMT): Greenwich Mean Time is mean (average) solar time at 0 degrees longitude, see UTC
+
+**<span translate="no">Guardrails</span>**&nbsp; (Guardrails): limits in the code for user selected settings, recommended and absolute limits are provided
+
+**<span translate="no">Hamburger Menu</span>**&nbsp; (Hamburger Menu): three parallel lines that, when tapped, open a new menu
+
+**<span translate="no">Identifiers</span>**&nbsp; (Identifiers): names of modules found on your Apple Developer Identifiers page that are required for GitHub build method
+
+**<span translate="no">IOB</span>**&nbsp; (IOB): Insulin on Board, affects automated insulin delivery: the current active insulin (above or below the basal rate)
+
+**<span translate="no">iOS</span>**&nbsp; (iOS): operating system used by Apple Mobile devices (iPhone, iPod, iPad)
+
+**<span translate="no">ISF</span>**&nbsp; (ISF): Insulin Sensitivity Factor; how many points your blood sugar will drop for each unit of insulin; sometimes called Correction Factor
+
+**<span translate="no">Issue</span>**&nbsp; (Issue): On github - a formal method to report a problem, either code behavior or documentation
+
+**<span translate="no">JSON</span>**&nbsp; (JSON): JavaScript Object Notation; a standard data interchange format that is text-based and human readable
+
+**<span translate="no">macOS</span>**&nbsp; (macOS): operating system for Mac computer
+
+**<span translate="no">Loop and Learn</span>**&nbsp; (Loop and Learn): A support group with mentors and developers who support the OS-AID community
+
+**<span translate="no">Loop</span>**&nbsp; (Loop): With a capital L, Loop is one of several do-it-yourself artifical pancreas systems
+
+**<span translate="no">LoopFollow</span>**&nbsp; (LoopFollow): LoopFollow combines custom alerts and display from many open-source apps such as Loop, Trio and Nigthscout
+
+**<span translate="no">Match-Secrets</span>**&nbsp; (Match-Secrets): a private repository you must create in your github account, stores keys required to build with github Build Actions
+
+**<span translate="no">MTB</span>**&nbsp; (MTB): Manual Temporary Basal: user initiated temporary basal, Omnipod Common feature
+
+**<span translate="no">MDT</span>**&nbsp; (MDT): common abbreviation for Medtronic pumps
+
+**<span translate="no">modal</span>**&nbsp; (modal): message or alert appearing in front of app that must be acknowledged to return to app
+
+**<span translate="no">NFC</span>**&nbsp; (NFC): Near-Field Communication is used for scanning devices such as Libre sensors
+
+**<span translate="no">Nightscout</span>**&nbsp; (Nightscout): a personal website used to view your glucose and diabetes management data.
+
+**<span translate="no">Omnipod</span>**&nbsp; (Omnipod): Insulet tubeless insulin pump
+
+**<span translate="no">OS-AID</span>**&nbsp; (OS-AID): Open Source Automated Insulin Delivery systems
+
+**<span translate="no">PR</span>**&nbsp; (PR): Pull Request - a formal method to request changes to a repository
+
+**<span translate="no">Provisioning Profile</span>**&nbsp; (Provisioning Profile): associates your app with your Developer ID and limits app lifetime to 1 year (paid) or 1 week (free)
+
+**<span translate="no">Pull Request</span>**&nbsp; (Pull Request): formal method to request changes to a repository
+
+**<span translate="no">QR</span>**&nbsp; (QR): a machine-readable code consisting of an array of black and white squares
+
+**<span translate="no">repository</span>**&nbsp; (repository): contains project files and each file's revision history
+
+**<span translate="no">TEAMID</span>**&nbsp; (TEAMID): One of 6 Secrets: Apple Developer account member number
+
+**<span translate="no">FASTLANE_ISSUER_ID</span>**&nbsp; (FASTLANE_ISSUER_ID): One of 6 Secrets: the issuer ID is associated with your Apple Developer ID and never changes
+
+**<span translate="no">FASTLANE_KEY_ID</span>**&nbsp; (FASTLANE_KEY_ID): One of 6 Secrets: Key ID provided when you create an API key in App Store Connect; it is associated with the FASTLANE_KEY
+
+**<span translate="no">FASTLANE_KEY</span>**&nbsp; (FASTLANE_KEY): One of 6 Secrets: Really long key (several lines); it and FASTLANE_KEY_ID are generated together
+
+**<span translate="no">GH_PAT</span>**&nbsp; (GH_PAT): One of 6 Secrets: Generated with your GitHub account; set it to never expire
+
+**<span translate="no">MATCH_PASSWORD</span>**&nbsp; (MATCH_PASSWORD): One of 6 Secrets: Git repo encryption passphrase, used to encrypt the Match-Secrets repository when it is created. You must save and use the same MATCH_PASSWORD for every repository if you build multiple apps.
+
+**<span translate="no">SHA-1</span>**&nbsp; (SHA-1): Secure Hash Algorithm 1; used to generate an alphanumeric code for commits in git (github)
+
+**<span translate="no">Terminal</span>**&nbsp; (Terminal): interface for entering commands to the computer
+
+**<span translate="no">TestFlight</span>**&nbsp; (TestFlight): a method to distribute apps without direct connection
+
+**<span translate="no">Tooltip</span>**&nbsp; (Tooltip): brief definitions provided for important terms and abbreviations on the website
+
+**<span translate="no">URL</span>**&nbsp; (URL): website address (Uniform Resource Locator)
+
+**<span translate="no">watchOS</span>**&nbsp; (watchOS): Apple watch operating system; must be compatible with phone iOS
+
+**<span translate="no">workflow</span>**&nbsp; (workflow): a set of instructions to GitHub to perform an action; the instruction files are found in the .github/workflows folder of the repository
+
+**<span translate="no">Xcode</span>**&nbsp; (Xcode): program used to build an app

docs/faqs/lf-faqs.md

@@ -0,0 +1,9 @@
+
+🚧 Documentation Under Construction 🚧
+
+<!--todo-->
+<!--Notes: be sure to add this info
+
+-->
+
+Pro Tip:  If you are experiencing audible and visible glucose alerts every single minute, disable Persistent Notifications. Go to LoopFollow, Settings, General Settings to see the screen in the graphic below.