Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs enhancements #1

Merged
merged 8 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
tmhastings marked this conversation as resolved.
Show resolved Hide resolved
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
86 changes: 49 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,91 @@
# iAPS
# Open-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.
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.

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.

iAPS uses lot of frameworks published by the Loop community.
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.

## To download this repo:
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:

In Terminal:
git clone --branch=main https://github.com/artificial-pancreas/iaps.git
cd iaps
xed .
git clone --branch=main https://github.com/nightscout/Open-iAPS.git
cd Open-iAPS
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
Instructions in greater detail, but not iAPS-specific:
https://github.com/nightscout/Open-iAPS/blob/main/fastlane/testflight.md
Instructions in greater detail, but not Open-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)
- Dana RS (COMING SOON)

# 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

# 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 iAPS - Server ](https://discord.com/invite/ptkk2Y264Z)
[Discord Open-iAPS - Server ](https://discord.gg/s5b6E4vHs3)

[Open-iAPS documentation (under development, not existing yet)](https://open-iaps.readthedocs.io/en/latest/)

[iAPS documentation (under development)](https://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 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 Open-iAPS (not existing yet)](https://github.com/nightscout/middleware)

[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

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).