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

Convert API Guide and iOS Doc to Markdown #56

Open
wants to merge 5 commits into
base: next
Choose a base branch
from
Open
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 removed OpenXC_iOS_Document.docx
Binary file not shown.
45 changes: 45 additions & 0 deletions OpenXC_iOS_Document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# OpenXC iOS

## Contents

* [Using VI with iOS](#using-vi-with-ios)
* [Install the Demo Application](#install-the-demo-application)
* [For Contributors](#for-contributors)
* [App Tutorial](#app-tutorial)
* Starter Application

## Using VI with iOS

So, you just bought an openxc VI? Let’s get it programmed and test it in a car with your iOS device or laptop. If you have issues at any point in this process, check for similar issues in the [Google Group](http://groups.google.com/group/openxc) or create a new post to ask for some assistance.

## Install the Demo Application

iOS openxc demo application is available on GitHub in the [openxc-ios-library](https://github.com/openxc/openxc-ios-library) repository.

Follow these steps to install it on your device:

1. Install XCode 8 or latest in your machine if not installed. ([steps to install XCode](https://developer.apple.com/xcode/downloads/))
1. Create an empty folder on your machine and name it accordingly.
1. Open terminal and go to that folder `cd <folder Path>`.
1. Copy the link from GitHub which you want to clone (master or next) branch.
1. Use command in terminal `git clone <link>` and press enter. It will start cloning the project inside your folder.
1. After cloning go to openxc-ios-library Example folder `cd openxc-ios-library/Example`.
1. If necessary, install cocoapods using `sudo gem install cocoapods`.
1. Run `pod install` from terminal. Note: May take a while.
1. Open .xcworkspace file and run the app in device or simulator.

That’s it! You can now proceed to the next steps to start using the library in your project.

## For Contributors

Clone the [openxc-ios-library](https://github.com/openxc/openxc-ios-library) repository using Git. If you don’t already have Git installed, GitHub has a [good reference](https://help.github.com/articles/set-up-git) for all platforms.

After cloning the `openxc-ios-library`, open the .xcworkspace inside Example in XCode. This should have `openxc-framework`, `protobuf`, `AppCenter` as part of project and other ios framework also.

Once you have the library set up, you can start writing your first openxc app using the steps mentioned below. If you are having trouble, check out the troubleshooting steps.

## App Tutorial

This tutorial assumes you have a working knowledge of how to create an iOS application. Setting up the development environment and understanding iOS fundamentals is outside the scope of openxc, and Apple already provides documentation and tutorials. The best place to start is [Apple developer portal](https://developer.apple.com/).

Once you’re comfortable with creating an iOS app, continue on with this tutorial to enrich it with data from your vehicle.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ The framework can be picked directly from the releases

Make sure you have XCode10 installed with iOS11 to build it from XCode. This framework must be included in any iOS application that needs to connect to a VI

Refer to this [document](https://github.com/openxc/openxc-ios-library/blob/master/OpenXC_iOS_Document.docx) for more details on installation and usage.
Refer to this [document](OpenXC_iOS_Document.md) for more details on installation and usage.

API usage details are available [here](https://github.com/openxc/openxc-ios-library/blob/master/iOS%20Framework%20API%20Guide.pdf).
API usage details are available [here](iOS%20Framework%20API%20Guide.md).

Also see [Step by Step Guide](https://github.com/openxc/openxc-ios-library/blob/master/StepsToBuildOpenXCiOSFrameworkAndDemoApp.docx) to build framework.

Expand Down
Binary file removed iOS Framework API Guide.docx
Binary file not shown.
Loading