Skip to content

Commit

Permalink
Documetn Changes
Browse files Browse the repository at this point in the history
  • Loading branch information
RanjaniOS committed Mar 28, 2019
1 parent 8523017 commit 37924fe
Show file tree
Hide file tree
Showing 9 changed files with 106 additions and 17 deletions.
32 changes: 32 additions & 0 deletions CHANGELOG.mkd
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# OpenXC iOS App Demo Changelog
## v3.0.0

* Feature: Hockey App SDK Integration for crash Annalytics.
* UI: Custom command UI added in Commands Page.
* UI: Settings screen cosmetic changes.
* UI: Disconnect Button on status page.
* Enhancement: Timestamp added in tracefile.
* Enhancement: Alert message if the device bluetooth is off.
* Enhancement: Alert messages on every page if trying to do some operation on C5 BLE if its disconnected state.
* Feature: Adding feature to send commands to VI if its connected

## v2.0.0

* Improvement: Support for iOS 11
* Feature: Added support to receive data from network source through Wi-Fi
* Feature: App will now pull and display the VI platform
* Bug Fixes
* Code Refactor and improvement in framework

## v1.2.0

* Feature: Adding feature to send commands to VI if its connected

## v1.1.0

* Improvement: Support for iOS 10
* Improvement: Migration to Swift3

## v1.0.0

* Initial release
46 changes: 46 additions & 0 deletions CONTRIBUTING.mkd
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# How to contribute


Contributions are welcome - we want to keep it as easy as possible to contribute
changes that get things working in your environment. There are a few guidelines
that we need contributors to follow so that we can have a chance of keeping on
top of things.

## Reporting an Issue

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Check if a ticket already exists for your issue on [GitHub](https://github.com/openxc/openxc-ios-app-demo)
* If one does not already exist, [create a new ticket](https://github.com/openxc/openxc-ios-app-demo/issues/new)
* Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you include in the earliest version that you know has the issue.
* Follow the [GitHub Labels document] (https://github.com/openxc/openxc-ios-app-demo/blob/master/Using%20GitHub%20Labels%20in%20OpenXC%20iOS.docx) when creating a new ticket

## Making Changes

* If you haven't already, create a new issue on [GitHub](https://github.com/openxc/openxc-ios-app-demo/issues/new) for your bug
fix or new feature.
* Fork the repository on GitHub
* Create a topic branch from where you want to base your work.
* This is usually the master branch.
* Only target release branches if you are certain your fix must be on that
branch.
* To quickly create a topic branch based on master; `git checkout -b
fix/master/my_contribution master`. Please avoid working directly on the
`master` branch.
* Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your commit messages are in the [proper format](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).


## Submitting Changes

* Push your changes to a topic branch in your fork of the repository.
* Sign the [Contributor License
Agreement](http://openxcplatform.com/contributor-license-agreement.html) (CLA)
* Submit a pull request to the repository in the openxc organization.

# Additional Resources

* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

6 changes: 6 additions & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Tim Buick tim@buglabs.net
Matt Peddicord matt.peddicord@buglabs.net
Eric Marsman emarsman@ford.com
Ryan Oberholzer roberhol@ford.com
Kanishka Vedi vkanishk@ford.com
Ranjan Kumar Sahu kranjan@ford.com
39 changes: 22 additions & 17 deletions LICENSE
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
Copyright (c) 2019 kranjanford <kranjan@ford.com>
Copyright (c) 2016 Ford Motor Company
All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the <organization> nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Binary file added OpenXC_iOS_Document.docx
Binary file not shown.
Binary file added StepsToBuildOpenXCiOSFrameworkAndDemoApp.docx
Binary file not shown.
Binary file added Using GitHub Labels in OpenXC iOS.docx
Binary file not shown.
Binary file added iOS Framework API Guide.docx
Binary file not shown.
Binary file added iOS Framework API Guide.pdf
Binary file not shown.

0 comments on commit 37924fe

Please sign in to comment.