HTML Objective-C CSS Other
Latest commit 3b7ef87 Jul 1, 2016 @kiryuxxu kiryuxxu committed on GitHub Update README.md

README.md


Physical computing toolkit for smartphones and tablets.

Version License Platform

※ バグ改善や要望以外の質問については konashiATux-xu.com 宛にご連絡下さい。

http://konashi.ux-xu.com
http://konashi-yukai.tumblr.com



Requirements

  • iOS 7.1 or later.
  • Xcode 7 or later.

Installation

Manually

ご自身のXcodeプロジェクトに手動でライブラリを追加するには次の手順を行う必要があります。

  1. Konashiフォルダ以下のファイルをXcodeのプロジェクトへコピーする。
  2. Linked Frameworks and LibrariesCoreBluetooth.frameworkJavaScriptCore.frameworkを追加する。
  3. Other Linker Flagsに-all_load-ObjCを追加する。

以上です。

Using CocoaPods

konashi-ios-sdk は CocoaPodsを用いてインストールすることが可能です。 最新版のSDKをインストールする際は、Podfileに次の1行を追加します。

pod 'konashi-ios-sdk'

一方、特定のバージョンをインストールする際は次のようにPodfileに記述します。

pod 'konashi-ios-sdk', '~> 3.0'

Getting Started

Usage

samplesフォルダ内に様々なサンプルプロジェクトを用意しています。

  • ACDriveExtension
  • ADCExtension
  • AioSample
  • BlinkLed
  • GettingStarted
  • GroveExtension
  • HardwareSample
  • I2cSample
  • JSBindingsSample
  • MultiNodeSample
  • PioDrive
  • PwmDrive
  • UartSample

Document

リポジトリ内のDocument/html/index.htmlから閲覧することが可能です。

開発について

機能要望やバグ報告をするには

開発者に要望を伝える報告する方法は以下です。

  • GitHub の Issues に投稿
  • Pull Request
    • バグ見つけて修正しといたよ、というときは Pull Request を develop ブランチに送ってください。
    • 詳細は ブランチの運用 をご覧ください。
  • “konashi" をキーワードにつぶやく
    • twitter で #konashi のハッシュをつけるか、 konashi というキーワードを使って tweet してください。
    • もしくは konashi をキーワードにブログに書いてください。
  • contact@ux-xu.com にメールする
    • メールでの報告も受け付けています。

ブランチの運用

git-flow を使用しています。各ブランチの役割は以下です。

  • master
    • リリース用のブランチです。GitHubでは master ブランチがデフォルトのブランチです。
  • develop
    • 開発用のブランチです。
  • feature/***
    • 新機能追加やバグ修正を行うブランチです。develop ブランチから feature ブランチを切り、開発が完了後に develop ブランチに merge します。
  • release/v***
    • リリース前ブランチです。develop ブランチから release ブランチを切り、テストが終わり次第 master ブランチにマージされます。(現在は基本的に origin に push されません)

タグの運用

基本的にリリース時にバージョン名でタグを切ります。konashi 公式ページからリンクされる zip ダウンロード先は最新のリリースタグの zip です。

タグ一覧はこちら

Pull Request

規模の大小関わらず、バグ修正や機能追加などの Pull Request 大歓迎!

Pull Request を送るにあたっての注意点は以下です。

  • 最新の develop ブランチから任意の名前でブランチを切り、実装後に develop ブランチに対して Pull Request を送ってください。
    • master ブランチへの Pull Request は(なるべく)ご遠慮ください。

ライセンス

konashi のソフトウェアのソースコード、ハードウェアに関するドキュメント・ファイルのライセンスは以下です。

  • ソフトウェア
  • ハードウェア
  • konashi のBLEモジュールのファームウェアは csr社 とのNDAのため公開しておりません。