Skip to content

update ReadMe with resetTransmitter build instructions #85

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 11, 2018
Merged

update ReadMe with resetTransmitter build instructions #85

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d20043
Merge pull request #1 from LoopKit/dev
Kdisimone Apr 10, 2018
43ef024
instructions for ResetTransmitter build
Kdisimone Apr 11, 2018
d7e7053
Update README.md
Kdisimone Apr 11, 2018
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
29 changes: 16 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A iOS framework providing an interface for communicating with the G5 glucose tra

This framework connects to a G5 Mobile Transmitter via Bluetooth LE. It does not connect to the G4 Share Receiver or any earlier CGM products.

## Installation
## Frameworks Installation

### Carthage

Expand All @@ -26,26 +26,29 @@ github "LoopKit/xDripG5"

Note that you'll need to confgure your target to link against `CommonCrypto.framework` in addition to `xDripG5.framework`

### CocoaPods

xDripG5 is available through [CocoaPods](http://cocoapods.org). To install
it, add the following line to your Podfile:

```ruby
pod "xDripG5"
```

## Usage

The quickest way to run the example project is via [CocoaPods](http://cocoapods.org). Run `pod try xDripG5` in the terminal.
Since Bluetooth LE is required, you will need to build and run on a real device.

If you plan to run your app alongside the G5 Mobile application, make sure to set `passiveModeEnabled` to true.

### Examples

[glucose-badge](https://github.com/dennisgove/glucose-badge) – Display the latest glucose values as an app icon badge

## ResetTransmitter App Installation

Download the XdripG5 code by clicking on the green `Clone or Download` button (scroll up on this page and you'll find it), then select `Download Zip`

![ResetTransmitter help](https://github.com/Kdisimone/images/blob/master/resetTransmitter-first.png)

Then navigate to the `XdripG5-dev` folder that just downloaded to your computer. Double-click on the `xDripG5.xcodeproj` file to open the project in Xcode.

![ResetTransmitter help](https://github.com/Kdisimone/images/blob/master/resetTransmitter-download.png)

To install the ResetTransmitter App on your iPhone, simply make sure to sign the ResetTransmitter target and then select just the `ResetTransmitter` scheme in the build area. Make sure your iPhone is plugged into the computer, select your iPhone from the top of the `Devices` in the 4th circled area, screenshot below. Note: You do not have to change bundle IDs or anything beyond the steps listed.

![ResetTransmitter help](https://github.com/Kdisimone/images/blob/master/resetTransmitter.png)


## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/LoopKit/LoopKit/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
Expand Down