Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
Binary file added Documentation/Changing the app icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,15 @@ Loop is built on top of [LoopKit](https://github.com/loudnate/LoopKit). LoopKit

# Getting Started

## Making It Your Own

Fork and clone this repository so you can commit the changes you'll make below.

### Assigning a Bundle Identifier
## Assigning a Bundle Identifier

[![Assigning a bundle identifier](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Assigning%20a%20bundle%20identifier.png)](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Assigning%20a%20bundle%20identifier.png)

In the Loop project's Build Settings, change the value of `MAIN_APP_BUNDLE_IDENTIFIER` to something unique. Usually this means replacing `com.loudnate` with a reverse-domain name of your choosing.

### Renaming The Target

[![Changing the target name](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Changing%20the%20target%20name.png)](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Changing%20the%20target%20name.png)

In the Targets list, rename "Loop" to anything you like. This has the side-effect of changing the display name of the app as well, though you can choose to decouple those if you like later by reading more about Xcode target configuration.

### Configuring RemoteSettings.plist
## Configuring RemoteSettings.plist

Loop supports select third-party remote services. They are all technically optional. However, including [mLab](https://mlab.com) keys is strongly recommended at this time so loop diagnostic data can be stored in case retrospective analysis is needed.

Expand All @@ -55,7 +47,7 @@ Every one of these values is technically optional.
| `ShareAccountName` | Your username for Dexcom share (for backfilling glucose data)
| `ShareAccountPassword` | Your password for Dexcom share

### Setting up Carthage
## Setting up Carthage

[Carthage](https://github.com/carthage/carthage) is used to manage dependencies. If you haven't installed Carthage on your Mac before, [follow the installation instructions](https://github.com/carthage/carthage#installing-carthage).

Expand All @@ -67,7 +59,25 @@ Loop$ carthage bootstrap

After pulling new changes, you'll need to run the same command again.

## Changing the code
# Making it Your Own

You might open this app a lot. Make it the most personal app on your iPhone by changing the name and icon.

### Renaming the Target

[![Changing the target name](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Changing%20the%20target%20name.png)](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Changing%20the%20target%20name.png)

In the Targets list, rename "Loop" to anything you like. This has the side-effect of changing the display name of the app as well, though you can choose to decouple those if you like later by reading more about Xcode target configuration.

### Changing the Icon

[![Changing the app icon](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Changing%20the%20app%20icon.png)](https://raw.githubusercontent.com/loudnate/Loop/master/Documentation/Changing%20the%20app%20icon.png)

1. Select the application asset library from the Project Navigator
2. Select the image set named AppIcon
3. Replace each image size with your own icon

# Changing the code

TODO: Write more documentation!

Expand Down