From ad223fd988b366b273b49bda45de2e86614bca23 Mon Sep 17 00:00:00 2001 From: Collin Jackson Date: Thu, 16 Jul 2015 16:39:40 -0700 Subject: [PATCH 1/2] README updates --- README.md | 4 ++-- sky/README.md | 10 +++++----- sky/sdk/README.md | 29 ++++++++++++----------------- 3 files changed, 19 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 516039a6f5209..a5a6aefd2d427 100644 --- a/README.md +++ b/README.md @@ -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). For information about contributing to Sky, please see [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/sky/README.md b/sky/README.md index 3a63fcd8060cf..00eaf2f87e572 100644 --- a/sky/README.md +++ b/sky/README.md @@ -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). diff --git a/sky/sdk/README.md b/sky/sdk/README.md index fbdfb7706d9c9..588d1a0a7f5d2 100644 --- a/sky/sdk/README.md +++ b/sky/sdk/README.md @@ -1,13 +1,13 @@ 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 === @@ -118,10 +118,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 @@ -156,10 +153,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 --------------------- @@ -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. 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. @@ -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 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. From e5d3f11dac837feaa104b61babf363377f461649 Mon Sep 17 00:00:00 2001 From: Collin Jackson Date: Thu, 16 Jul 2015 16:43:46 -0700 Subject: [PATCH 2/2] more updates --- README.md | 2 +- sky/sdk/README.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a5a6aefd2d427..346a3cbdfa34d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ 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 the latest stable release of Sky, please -see the [Sky SDK README](sky/sdk/README). +see the [Sky SDK README](sky/sdk/README.md). For information about contributing to Sky, please see [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/sky/sdk/README.md b/sky/sdk/README.md index 588d1a0a7f5d2..daae838b09bbe 100644 --- a/sky/sdk/README.md +++ b/sky/sdk/README.md @@ -3,9 +3,11 @@ Contributing 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) +[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/sky_engine/tree/master/sky/sdk). Pull +[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)!