Commit 073f9e3d authored by Collin Jackson's avatar Collin Jackson

README updates

parent e70a5c94
Contributing Contributing
============ ============
[sky_sdk](https://github.com/domokit/sky_sdk) is generated from the This SDK is generated from the
[mojo repository](https://github.com/domokit/mojo) using [Sky repository](https://github.com/domokit/sky_engine) using
[deploy_sdk.py](https://github.com/domokit/mojo/blob/master/sky/tools/deploy_sdk.py) [deploy_sdk.py](https://github.com/domokit/sky_engine/blob/master/sky/tools/deploy_sdk.py)
Static files (including this README.md) are located under Static files (including this README.md) are located under
[sky/sdk](https://github.com/domokit/mojo/tree/master/sky/sdk). Pull [sky/sdk](https://github.com/domokit/sky_engine/tree/master/sky/sdk). Pull
requests and issue reports are glady accepted at the requests and issue reports are gladly accepted at the
[mojo repository](https://github.com/domokit/mojo)! [Sky repository](https://github.com/domokit/sky_engine)!
Sky Sky
=== ===
...@@ -118,10 +118,7 @@ Set up your computer ...@@ -118,10 +118,7 @@ Set up your computer
2. Install the `adb` tool from the Android SDK: 2. Install the `adb` tool from the Android SDK:
- https://developer.android.com/sdk/installing/index.html - https://developer.android.com/sdk/installing/index.html
3. Install the Sky SDK: 3. Ensure that `$DART_SDK` is set to the path of your Dart SDK and `adb`
- `git clone https://github.com/domokit/sky_sdk.git`
4. Ensure that `$DART_SDK` is set to the path of your Dart SDK and `adb`
(inside `platform-tools` in the android sdk) is in your `$PATH`. (inside `platform-tools` in the android sdk) is in your `$PATH`.
Set up your device Set up your device
...@@ -156,10 +153,8 @@ run one of the examples in this SDK, try: ...@@ -156,10 +153,8 @@ run one of the examples in this SDK, try:
installed on the device.) installed on the device.)
4. Use `adb logcat` to view any errors or Dart `print()` output from the app. 4. Use `adb logcat` to view any errors or Dart `print()` output from the app.
`adb logcat -s chromium` can be used to filter only adb messages from `adb logcat -s sky` can be used to filter only adb messages from
`SkyDemo.apk` (which for `SkyDemo.apk`.
[legacy reasons](https://github.com/domokit/mojo/issues/129) still uses the
android log tag `chromium`).
Measuring Performance Measuring Performance
--------------------- ---------------------
...@@ -187,7 +182,7 @@ Although it is possible to bundle the Sky Engine in your own app (instead of ...@@ -187,7 +182,7 @@ Although it is possible to bundle the Sky Engine in your own app (instead of
running your code inside SkyDemo.apk), right now doing so is difficult. running your code inside SkyDemo.apk), right now doing so is difficult.
There is one example of doing so if you're feeling brave: There is one example of doing so if you're feeling brave:
https://github.com/domokit/mojo/tree/master/sky/sdk/example/stocks https://github.com/domokit/sky_engine/tree/master/sky/sdk/example/stocks
Eventually we plan to make this much easier and support platforms other than Eventually we plan to make this much easier and support platforms other than
Android, but that work is yet in progress. Android, but that work is yet in progress.
...@@ -210,8 +205,8 @@ service to allow Sky Framework Dart code to interface with the underlying ...@@ -210,8 +205,8 @@ service to allow Sky Framework Dart code to interface with the underlying
platform's Keyboard, but also to expose any additional non-Dart business logic platform's Keyboard, but also to expose any additional non-Dart business logic
to Sky/Dart UI code. to Sky/Dart UI code.
As an example, [SkyApplication](https://github.com/domokit/mojo/blob/master/sky/shell/org/domokit/sky/shell/SkyApplication.java) As an example, [SkyApplication](https://github.com/domokit/sky_engine/blob/master/sky/shell/org/domokit/sky/shell/SkyApplication.java)
exposes a mojo `network_service` (required by Sky Engine C++ code) exposes a mojo `network_service` (required by Sky Engine C++ code)
[SkyDemoApplication](https://github.com/domokit/mojo/blob/master/sky/apk/demo/org/domokit/sky/demo/SkyDemoApplication.java) [SkyDemoApplication](https://github.com/domokit/sky_engine/blob/master/sky/apk/demo/org/domokit/sky/demo/SkyDemoApplication.java)
additionally exposes `keyboard_service` and `sensor_service` for use by the Sky additionally exposes `keyboard_service` and `sensor_service` for use by the Sky
Framework from Dart. Framework from Dart.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment