From 2d5d16e686dabd766e8fdb5bb366380ce045bf16 Mon Sep 17 00:00:00 2001 From: lifeguardz Date: Tue, 5 Mar 2024 15:47:28 +0100 Subject: [PATCH 1/8] update docs --- CODE_OF_CONDUCT.md | 4 +-- README.md | 64 +++++++++++++++++++++++----------------------- 2 files changed, 33 insertions(+), 35 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index ec08adf0f..b3949e2a5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -58,9 +58,7 @@ representative at an online or offline event. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -jon.m@live.se. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the Discord server admins. Please join our Discord server to contac them directly for any enforcement issues. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/README.md b/README.md index 489f34304..4b5972d2e 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,52 @@ # iAPS -## Introduction +## Introduction -iAPS - an artificial pancreas system for iOS based on [OpenAPS Reference](https://github.com/openaps/oref0) algorithms (Master 0.7.1) and Ivan Valkous stale Swift repo, freeaps.git. +iAPS - an artificial pancreas system for iOS based on [Open-iAPS-oref Reference](https://github.com/nightscout/open-iaps-oref) algorithms (Master 0.7.1) and Ivan Valkous stale Swift repo, freeaps.git. -Thousands of commits later, with many new and unique features added, the iOS app has been renamed to iAPS under a new organisation, Artificial Pancreas. +Thousands of commits later, with many new and unique features added, the iOS app has been renamed to iAPS under a new organisation, Artificial Pancreas. -iAPS uses lot of frameworks published by the Loop community. +iAPS uses lot of frameworks published by the Loop community. -## To download this repo: +## To download this repo: In Terminal: git clone --branch=main https://github.com/artificial-pancreas/iaps.git cd iaps -xed . +xed . -Or using the GitHub interface: -Download and open in Xcode directly using the Code button: "Open with Xcode". +Or using the GitHub interface: +Download and open in Xcode directly using the Code button: "Open with Xcode". -## To build directly in GitHub, without using Xcode: +## To build directly in GitHub, without using Xcode: Instructions: -https://github.com/Artificial-Pancreas/iAPS/blob/main/fastlane/testflight.md +https://github.com/nightscout/Open-iAPS/blob/main/fastlane/testflight.md Instructions in greater detail, but not iAPS-specific: https://loopkit.github.io/loopdocs/gh-actions/gh-overview/ - -## Please understand that iAPS is: + +## Please understand that iAPS is: - highly experimental and evolving rapidly. - not CE or FDA approved for therapy. # Pumps -- Omnipod EROS -- Omnipod DASH -- Medtronic 515 or 715 (any firmware) -- Medtronic 522 or 722 (any firmware) -- Medtronic 523 or 723 (firmware 2.4 or lower) -- Medtronic Worldwide Veo 554 or 754 (firmware 2.6A or lower) -- Medtronic Canadian/Australian Veo 554 or 754 (firmware 2.7A or lower) +- Omnipod EROS +- Omnipod DASH +- Medtronic 515 or 715 (any firmware) +- Medtronic 522 or 722 (any firmware) +- Medtronic 523 or 723 (firmware 2.4 or lower) +- Medtronic Worldwide Veo 554 or 754 (firmware 2.6A or lower) +- Medtronic Canadian/Australian Veo 554 or 754 (firmware 2.7A or lower) # CGM Sensors -- Dexcom G5 -- Dexcom G6 -- Dexcom ONE -- Dexcom G7 -- Libre 1 -- Libre 2 (European) +- Dexcom G5 +- Dexcom G6 +- Dexcom ONE +- Dexcom G7 +- Libre 1 +- Libre 2 (European) - Medtronic Enlite - Nightscout as CGM @@ -56,16 +56,16 @@ iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum iOS 1 # Documentation -[Discord iAPS - Server ](https://discord.com/invite/ptkk2Y264Z) +[Discord Open-iAPS - Server ](https://discord.gg/s5b6E4vHs3) -[iAPS documentation (under development)](https://iaps.readthedocs.io/en/latest/) +[iAPS documentation (under development, not existing yet)](https://open-iaps.readthedocs.io/en/latest/) [OpenAPS documentation](https://openaps.readthedocs.io/en/latest/) -[Crowdin Project for translation of iAPS](https://crowdin.com/project/iaps) -[![Crowdin](https://badges.crowdin.net/iaps/localized.svg)](https://crowdin.com/project/iaps) +[Crowdin Project for translation of Open-iAPS (not existing yet)](https://crowdin.com/project/open-iaps) +[![Crowdin (not existing yet)](https://badges.crowdin.net/iaps/localized.svg)](https://crowdin.com/project/open-iaps) -[Middleware code for iAPS](https://github.com/Jon-b-m/middleware) +[Middleware code for iAPS (not existing yet)](https://github.com/nightscout/middleware) [ADD DASH PUMP and SETTINGS](https://loopkit.github.io/loopdocs/loop-3/omnipod/) @@ -74,6 +74,6 @@ iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum iOS 1 Code contributions as PRs are welcome! -Translators can click the Crowdin link above +Translators can click the Crowdin link above. -For questions or other contributions: jon.m@live.se +For questions or contributions, please join our [Discord server](https://discord.gg/s5b6E4vHs3). From bcf988dbfd95e2659c412ffdc7f3581504a052aa Mon Sep 17 00:00:00 2001 From: Sjoerd-Bo3 Date: Tue, 5 Mar 2024 16:28:21 +0100 Subject: [PATCH 2/8] docs: fixed open-iaps references --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4b5972d2e..4653a036d 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ -# iAPS +# Open-iAPS ## Introduction -iAPS - an artificial pancreas system for iOS based on [Open-iAPS-oref Reference](https://github.com/nightscout/open-iaps-oref) algorithms (Master 0.7.1) and Ivan Valkous stale Swift repo, freeaps.git. +Open-iAPS - an artificial pancreas system for iOS based on [Open-iAPS-oref Reference](https://github.com/nightscout/open-iaps-oref) algorithms (Master 0.7.1) and Ivan Valkous stale Swift repo, freeaps.git. Thousands of commits later, with many new and unique features added, the iOS app has been renamed to iAPS under a new organisation, Artificial Pancreas. -iAPS uses lot of frameworks published by the Loop community. +//TODO: ADD Open-iAPS bit + +Open-iAPS uses lot of frameworks published by the Loop community. ## To download this repo: In Terminal: -git clone --branch=main https://github.com/artificial-pancreas/iaps.git -cd iaps +git clone --branch=main https://github.com/nightscout/Open-iAPS.git +cd Open-iAPS xed . Or using the GitHub interface: @@ -22,7 +24,7 @@ Download and open in Xcode directly using the Code button: "Open with Xcode". Instructions: https://github.com/nightscout/Open-iAPS/blob/main/fastlane/testflight.md -Instructions in greater detail, but not iAPS-specific: +Instructions in greater detail, but not Open-iAPS-specific: https://loopkit.github.io/loopdocs/gh-actions/gh-overview/ ## Please understand that iAPS is: @@ -38,6 +40,7 @@ https://loopkit.github.io/loopdocs/gh-actions/gh-overview/ - Medtronic 523 or 723 (firmware 2.4 or lower) - Medtronic Worldwide Veo 554 or 754 (firmware 2.6A or lower) - Medtronic Canadian/Australian Veo 554 or 754 (firmware 2.7A or lower) +- Dana RS (SOON) # CGM Sensors @@ -52,20 +55,20 @@ https://loopkit.github.io/loopdocs/gh-actions/gh-overview/ # iPhone and iPod -iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum iOS 16. +Open-iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum iOS 16. # Documentation [Discord Open-iAPS - Server ](https://discord.gg/s5b6E4vHs3) -[iAPS documentation (under development, not existing yet)](https://open-iaps.readthedocs.io/en/latest/) +[Open-iAPS documentation (under development, not existing yet)](https://open-iaps.readthedocs.io/en/latest/) [OpenAPS documentation](https://openaps.readthedocs.io/en/latest/) [Crowdin Project for translation of Open-iAPS (not existing yet)](https://crowdin.com/project/open-iaps) [![Crowdin (not existing yet)](https://badges.crowdin.net/iaps/localized.svg)](https://crowdin.com/project/open-iaps) -[Middleware code for iAPS (not existing yet)](https://github.com/nightscout/middleware) +[Middleware code for Open-iAPS (not existing yet)](https://github.com/nightscout/middleware) [ADD DASH PUMP and SETTINGS](https://loopkit.github.io/loopdocs/loop-3/omnipod/) From 0dec959f5c32d87426f240e6a093ab1b3ebe95d5 Mon Sep 17 00:00:00 2001 From: lifeguardz Date: Tue, 5 Mar 2024 16:41:32 +0100 Subject: [PATCH 3/8] update docs --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4653a036d..30f9e27af 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ Open-iAPS - an artificial pancreas system for iOS based on [Open-iAPS-oref Reference](https://github.com/nightscout/open-iaps-oref) algorithms (Master 0.7.1) and Ivan Valkous stale Swift repo, freeaps.git. -Thousands of commits later, with many new and unique features added, the iOS app has been renamed to iAPS under a new organisation, Artificial Pancreas. +The project has seen substantial contributions from many developers, leading to a range of new features and enhancements. -//TODO: ADD Open-iAPS bit +Following the release of version [2.3.3](https://github.com/Artificial-Pancreas/iAPS/releases/tag/v2.3.3), due to differing views on development and code quality, there was a significant shift in the project's direction. This led to the separation from the [Artificial-Pancreas/iAPS](https://github.com/Artificial-Pancreas/iAPS) repository, and the birth of Open-iAPS as a distinct entity. This transition marks a new phase for the project, symbolizing both its evolution and the dynamic nature of collaborative development. -Open-iAPS uses lot of frameworks published by the Loop community. +Open-iAPS continues to leverage a variety of frameworks from the Loop community and remains at the forefront of DIY diabetes management solutions, constantly evolving with valuable contributions from its community. ## To download this repo: From 4fdb754791b978d5098e08292f04b469500027e1 Mon Sep 17 00:00:00 2001 From: tmhastings <31315442+tmhastings@users.noreply.github.com> Date: Tue, 5 Mar 2024 10:51:16 -0500 Subject: [PATCH 4/8] Update README.md Changed version that instigated the move to a separate repo. The release of 3.0.0 was the catalyst, not 2.3.3. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 30f9e27af..801b2ed25 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Open-iAPS - an artificial pancreas system for iOS based on [Open-iAPS-oref Refer The project has seen substantial contributions from many developers, leading to a range of new features and enhancements. -Following the release of version [2.3.3](https://github.com/Artificial-Pancreas/iAPS/releases/tag/v2.3.3), due to differing views on development and code quality, there was a significant shift in the project's direction. This led to the separation from the [Artificial-Pancreas/iAPS](https://github.com/Artificial-Pancreas/iAPS) repository, and the birth of Open-iAPS as a distinct entity. This transition marks a new phase for the project, symbolizing both its evolution and the dynamic nature of collaborative development. +Following the release of version 3.0.0, due to differing views on development and code quality, there was a significant shift in the project's direction. This led to the separation from the [Artificial-Pancreas/iAPS](https://github.com/Artificial-Pancreas/iAPS) repository, and the birth of Open-iAPS as a distinct entity. This transition marks a new phase for the project, symbolizing both its evolution and the dynamic nature of collaborative development. Open-iAPS continues to leverage a variety of frameworks from the Loop community and remains at the forefront of DIY diabetes management solutions, constantly evolving with valuable contributions from its community. From c7c6e5f418abf633bf04c83fdb693ab8d181e762 Mon Sep 17 00:00:00 2001 From: tmhastings <31315442+tmhastings@users.noreply.github.com> Date: Tue, 5 Mar 2024 11:14:12 -0500 Subject: [PATCH 5/8] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 801b2ed25..312fa1871 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ ## Introduction -Open-iAPS - an artificial pancreas system for iOS based on [Open-iAPS-oref Reference](https://github.com/nightscout/open-iaps-oref) algorithms (Master 0.7.1) and Ivan Valkous stale Swift repo, freeaps.git. +Open-iAPS - an automated insulin delivery system for iOS based on [Open-iAPS-oref Reference](https://github.com/nightscout/open-iaps-oref) algorithms (Master 0.7.1) and Ivan Valkou's stale Swift repo, freeaps.git. The project has seen substantial contributions from many developers, leading to a range of new features and enhancements. Following the release of version 3.0.0, due to differing views on development and code quality, there was a significant shift in the project's direction. This led to the separation from the [Artificial-Pancreas/iAPS](https://github.com/Artificial-Pancreas/iAPS) repository, and the birth of Open-iAPS as a distinct entity. This transition marks a new phase for the project, symbolizing both its evolution and the dynamic nature of collaborative development. -Open-iAPS continues to leverage a variety of frameworks from the Loop community and remains at the forefront of DIY diabetes management solutions, constantly evolving with valuable contributions from its community. +Open-iAPS continues to leverage a variety of frameworks from the DIY looping community and remains at the forefront of DIY diabetes management solutions, constantly evolving with valuable contributions from its community. ## To download this repo: @@ -40,7 +40,7 @@ https://loopkit.github.io/loopdocs/gh-actions/gh-overview/ - Medtronic 523 or 723 (firmware 2.4 or lower) - Medtronic Worldwide Veo 554 or 754 (firmware 2.6A or lower) - Medtronic Canadian/Australian Veo 554 or 754 (firmware 2.7A or lower) -- Dana RS (SOON) +- Dana RS (COMING SOON) # CGM Sensors @@ -63,6 +63,8 @@ Open-iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum [Open-iAPS documentation (under development, not existing yet)](https://open-iaps.readthedocs.io/en/latest/) +[Open-iAPS Website (under development)](https://iaps-app.org) + [OpenAPS documentation](https://openaps.readthedocs.io/en/latest/) [Crowdin Project for translation of Open-iAPS (not existing yet)](https://crowdin.com/project/open-iaps) @@ -72,6 +74,13 @@ Open-iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum [ADD DASH PUMP and SETTINGS](https://loopkit.github.io/loopdocs/loop-3/omnipod/) +# Support + +[Open-iAPS Facebook Group](https://m.facebook.com/groups/1351938092206709/) + +[Loop and Learn Facebook Group](https://m.facebook.com/groups/LOOPandLEARN/) + +[Looped Facebook Group](https://m.facebook.com/groups/TheLoopedGroup/) # Contribute From fe77689ae0ed8211f51a920d9523577c66b1789a Mon Sep 17 00:00:00 2001 From: tmhastings <31315442+tmhastings@users.noreply.github.com> Date: Tue, 5 Mar 2024 13:04:30 -0500 Subject: [PATCH 6/8] Update CODE_OF_CONDUCT.md Typo: "contac" changed to "contact" --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b3949e2a5..78d6d1208 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -58,7 +58,7 @@ representative at an online or offline event. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the Discord server admins. Please join our Discord server to contac them directly for any enforcement issues. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the Discord server admins. Please join our Discord server to contact them directly for any enforcement issues. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the From 3a08e18ece30f1c700cd49faed510b277380a82c Mon Sep 17 00:00:00 2001 From: tmhastings <31315442+tmhastings@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:41:20 -0500 Subject: [PATCH 7/8] Update README.md Update Discord Invitation link to show coming from the Open-iAPS Official discord account --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 312fa1871..90ea49ae6 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Open-iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum # Documentation -[Discord Open-iAPS - Server ](https://discord.gg/s5b6E4vHs3) +[Discord Open-iAPS - Server ](https://discord.gg/dbe5Twav8D) [Open-iAPS documentation (under development, not existing yet)](https://open-iaps.readthedocs.io/en/latest/) @@ -88,4 +88,4 @@ Code contributions as PRs are welcome! Translators can click the Crowdin link above. -For questions or contributions, please join our [Discord server](https://discord.gg/s5b6E4vHs3). +For questions or contributions, please join our [Discord server](https://discord.gg/dbe5Twav8D). From 799d1c4ac9e04edb3332060931a089182e90e14a Mon Sep 17 00:00:00 2001 From: bjornoleh <63544115+bjornoleh@users.noreply.github.com> Date: Tue, 5 Mar 2024 23:46:59 +0100 Subject: [PATCH 8/8] Update README.md - reword introduction - delete middleware reference from readme --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 90ea49ae6..affa5e675 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,10 @@ ## Introduction -Open-iAPS - an automated insulin delivery system for iOS based on [Open-iAPS-oref Reference](https://github.com/nightscout/open-iaps-oref) algorithms (Master 0.7.1) and Ivan Valkou's stale Swift repo, freeaps.git. +Open-iAPS - an automated insulin delivery system for iOS based on the OpenAPS algorithm with [adaptations for Open iAPS](https://github.com/nightscout/open-iaps-oref). -The project has seen substantial contributions from many developers, leading to a range of new features and enhancements. +The project started as Ivan Valkou's FreeAPS X implementation of the OpenAPS algorithm for iPhone, and later forked and rebranded as iAPS. +The project has since seen substantial contributions from many developers, leading to a range of new features and enhancements. Following the release of version 3.0.0, due to differing views on development and code quality, there was a significant shift in the project's direction. This led to the separation from the [Artificial-Pancreas/iAPS](https://github.com/Artificial-Pancreas/iAPS) repository, and the birth of Open-iAPS as a distinct entity. This transition marks a new phase for the project, symbolizing both its evolution and the dynamic nature of collaborative development. @@ -70,8 +71,6 @@ Open-iAPS app runs on iPhone or iPod. An iPhone 8 or newer is required. Minimum [Crowdin Project for translation of Open-iAPS (not existing yet)](https://crowdin.com/project/open-iaps) [![Crowdin (not existing yet)](https://badges.crowdin.net/iaps/localized.svg)](https://crowdin.com/project/open-iaps) -[Middleware code for Open-iAPS (not existing yet)](https://github.com/nightscout/middleware) - [ADD DASH PUMP and SETTINGS](https://loopkit.github.io/loopdocs/loop-3/omnipod/) # Support