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

README updates #68

Merged
merged 2 commits into from
Jul 16, 2015
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ More specifically, Sky is a rendering engine, a scripting engine, an
Sky is optimized for today's, and tomorrow's, mobile devices. We are focused
on low-latency input, high frame rates, and we are purely mobile first.

For information about using our latest stable release of Sky, please
see the [Sky SDK](https://github.com/domokit/sky_sdk/) project page.
For information about using the latest stable release of Sky, please
see the [Sky SDK README](sky/sdk/README.md).

For information about contributing to Sky, please see
[CONTRIBUTING.md](CONTRIBUTING.md).
10 changes: 5 additions & 5 deletions sky/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Sky
===

For information about using our latest stable release of Sky, please
see the [Sky SDK](https://github.com/domokit/sky_sdk/) project page.
For information about using the latest stable release of Sky, please see the
[Sky SDK](sdk/).

For more current information about the bleeding edge of the Sky
framework, see [the sdk/ directory](sdk/lib/).
For more information about the Sky framework, see
[the sdk/lib directory](sdk/lib/).

For details about the internals of Sky's engine, see [the engine/
directory](engine/).

For information about contributing to Sky, please see
[HACKING.md](HACKING.md).
[CONTRIBUTING.md](../CONTRIBUTING.md).
31 changes: 14 additions & 17 deletions sky/sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
Contributing
============

[sky_sdk](https://github.com/domokit/sky_sdk) is generated from the
[mojo repository](https://github.com/domokit/mojo) using
[deploy_sdk.py](https://github.com/domokit/mojo/blob/master/sky/tools/deploy_sdk.py)
This SDK is generated from the
[Sky repository](https://github.com/domokit/sky_engine) using
[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
[sky/sdk](https://github.com/domokit/mojo/tree/master/sky/sdk). Pull
requests and issue reports are glady accepted at the
[mojo repository](https://github.com/domokit/mojo)!
[sky/sdk](https://github.com/domokit/sky_engine/tree/master/sky/sdk).

Pull
requests and issue reports are gladly accepted at the
[Sky repository](https://github.com/domokit/sky_engine)!

Sky
===
Expand Down Expand Up @@ -118,10 +120,7 @@ Set up your computer
2. Install the `adb` tool from the Android SDK:
- https://developer.android.com/sdk/installing/index.html

3. Install the Sky SDK:
- `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`
3. 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`.

Set up your device
Expand Down Expand Up @@ -156,10 +155,8 @@ run one of the examples in this SDK, try:
installed on the device.)

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
`SkyDemo.apk` (which for
[legacy reasons](https://github.com/domokit/mojo/issues/129) still uses the
android log tag `chromium`).
`adb logcat -s sky` can be used to filter only adb messages from
`SkyDemo.apk`.

Measuring Performance
---------------------
Expand Down Expand Up @@ -187,7 +184,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.

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
Android, but that work is yet in progress.
Expand All @@ -210,8 +207,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
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)
[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
Framework from Dart.