Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit c8874f9

Browse files
committed
Merge pull request #68 from collinjackson/readme
README updates R=eseidel
2 parents bbeb950 + e5d3f11 commit c8874f9

File tree

3 files changed

+21
-24
lines changed

3 files changed

+21
-24
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ More specifically, Sky is a rendering engine, a scripting engine, an
77
Sky is optimized for today's, and tomorrow's, mobile devices. We are focused
88
on low-latency input, high frame rates, and we are purely mobile first.
99

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

1313
For information about contributing to Sky, please see
1414
[CONTRIBUTING.md](CONTRIBUTING.md).

sky/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Sky
22
===
33

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

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

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

1313
For information about contributing to Sky, please see
14-
[HACKING.md](HACKING.md).
14+
[CONTRIBUTING.md](../CONTRIBUTING.md).

sky/sdk/README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
Contributing
22
============
33

4-
[sky_sdk](https://github.com/domokit/sky_sdk) is generated from the
5-
[mojo repository](https://github.com/domokit/mojo) using
6-
[deploy_sdk.py](https://github.com/domokit/mojo/blob/master/sky/tools/deploy_sdk.py)
4+
This SDK is generated from the
5+
[Sky repository](https://github.com/domokit/sky_engine) using
6+
[deploy_sdk.py](https://github.com/domokit/sky_engine/blob/master/sky/tools/deploy_sdk.py).
77
Static files (including this README.md) are located under
8-
[sky/sdk](https://github.com/domokit/mojo/tree/master/sky/sdk). Pull
9-
requests and issue reports are glady accepted at the
10-
[mojo repository](https://github.com/domokit/mojo)!
8+
[sky/sdk](https://github.com/domokit/sky_engine/tree/master/sky/sdk).
9+
10+
Pull
11+
requests and issue reports are gladly accepted at the
12+
[Sky repository](https://github.com/domokit/sky_engine)!
1113

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

121-
3. Install the Sky SDK:
122-
- `git clone https://github.com/domokit/sky_sdk.git`
123-
124-
4. Ensure that `$DART_SDK` is set to the path of your Dart SDK and `adb`
123+
3. Ensure that `$DART_SDK` is set to the path of your Dart SDK and `adb`
125124
(inside `platform-tools` in the android sdk) is in your `$PATH`.
126125

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

158157
4. Use `adb logcat` to view any errors or Dart `print()` output from the app.
159-
`adb logcat -s chromium` can be used to filter only adb messages from
160-
`SkyDemo.apk` (which for
161-
[legacy reasons](https://github.com/domokit/mojo/issues/129) still uses the
162-
android log tag `chromium`).
158+
`adb logcat -s sky` can be used to filter only adb messages from
159+
`SkyDemo.apk`.
163160

164161
Measuring Performance
165162
---------------------
@@ -187,7 +184,7 @@ Although it is possible to bundle the Sky Engine in your own app (instead of
187184
running your code inside SkyDemo.apk), right now doing so is difficult.
188185

189186
There is one example of doing so if you're feeling brave:
190-
https://github.com/domokit/mojo/tree/master/sky/sdk/example/stocks
187+
https://github.com/domokit/sky_engine/tree/master/sky/sdk/example/stocks
191188

192189
Eventually we plan to make this much easier and support platforms other than
193190
Android, but that work is yet in progress.
@@ -210,8 +207,8 @@ service to allow Sky Framework Dart code to interface with the underlying
210207
platform's Keyboard, but also to expose any additional non-Dart business logic
211208
to Sky/Dart UI code.
212209

213-
As an example, [SkyApplication](https://github.com/domokit/mojo/blob/master/sky/shell/org/domokit/sky/shell/SkyApplication.java)
210+
As an example, [SkyApplication](https://github.com/domokit/sky_engine/blob/master/sky/shell/org/domokit/sky/shell/SkyApplication.java)
214211
exposes a mojo `network_service` (required by Sky Engine C++ code)
215-
[SkyDemoApplication](https://github.com/domokit/mojo/blob/master/sky/apk/demo/org/domokit/sky/demo/SkyDemoApplication.java)
212+
[SkyDemoApplication](https://github.com/domokit/sky_engine/blob/master/sky/apk/demo/org/domokit/sky/demo/SkyDemoApplication.java)
216213
additionally exposes `keyboard_service` and `sensor_service` for use by the Sky
217214
Framework from Dart.

0 commit comments

Comments
 (0)