diff --git a/README.md b/README.md index e4abe59f8b..fc98685c7d 100644 --- a/README.md +++ b/README.md @@ -26,73 +26,9 @@ Please understand that this project: Screenshot of bolus failure notification on Apple Watch Screenshot of bolus failure notification on Apple Watch -# Requirements +# Documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Insulin Pump
MM 515/7152MM 522/7222MM 523/7233MM 554/7543
CGMDexcom G41
Dexcom G5
MM CGM4
- -
1. Offline access to glucose requires a Receiver with Share and the [Share2 app](https://itunes.apple.com/us/app/dexcom-share2/id834775275?mt=8) to be running on the same device. Internet-dependent access via Share servers is also supported. -
2. Pump must have a remote ID added in the [Remote Options](https://www.medtronicdiabetes.com/sites/default/files/library/download-library/workbooks/x22_menu_map.pdf) menu. -
3. Early firmware (US <= 2.4A, AU/EUR <= 2.6A) is required for using Closed Loop and Bolus features. -
4. It's not impossible, but comms-heavy and there's [some work to be done](https://github.com/LoopKit/Loop/issues/100). - -### Mac and Xcode - -To build Loop you will need a Mac, and have Xcode 8 installed on it. You can build Loop without an Apple Developer Account, but any apps built this way will expire after a week, so signing up for the $99 developer account is recommended. - -### iOS Phone - -Loop will run on on any iPhone that is compatible with iOS 10. - -### RileyLink - -Bluetooth LE communication with Minimed pumps is enabled by the [RileyLink](https://github.com/ps2/rileylink), a compact BLE-to-916MHz bridge device designed by [@ps2](https://github.com/ps2). Please visit the [repository](https://github.com/ps2/rileylink) and the [gitter room](https://gitter.im/ps2/rileylink) for more information. - -### Carthage - -[Carthage](https://github.com/carthage/carthage) is used to manage framework dependencies. It will need to be [installed on your Mac](https://github.com/carthage/carthage#installing-carthage) to build and run the app, but most users won't have a need to explicitly rebuild any dependencies. - -# Getting Started - -[Sign up for the Loop Users announcement list](https://groups.google.com/forum/#!forum/loop-ios-users) to stay informed of critical issues that may arise. - -Please use the [Guide to Loop](https://github.com/LoopKit/Loop/wiki/Guide) for building, installation, and configuration instructions. +Please visit the [Loop Docs](https://loopkit.github.io/loopdocs/) for installation, algorithm, and other details. For FAQs and other tips, refer to the [Wiki](https://github.com/LoopKit/Loop/wiki)