Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(797)

Unified Diff: sky/SDK.md

Issue 968213005: Add instructions for using the Sky SDK (Closed) Base URL: git@github.com:domokit/mojo.git@master
Patch Set: Created 5 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sky/SDK.md
diff --git a/sky/SDK.md b/sky/SDK.md
new file mode 100644
index 0000000000000000000000000000000000000000..1f4be07a6c01e4f1906531e4a74d9d4c946f0e49
--- /dev/null
+++ b/sky/SDK.md
@@ -0,0 +1,40 @@
+Sky SDK
+=======
+
+This document describes an experimental development kit for Sky. We're still
+iterating on Sky heavily, which means the framework and underlying engine are
+both likely to change in incompatible ways several times, but if you're
+interested in trying out the system, this document can help you get started.
+
+Set up your device
+------------------
+
+Currently Sky requires an Android device running the Lollipop (or newer) version
+of the Android operating system.
+
+1. Install ``Sky`` on your device by via the Play Store. The Sky app on your
eseidel 2015/03/02 22:51:52 We'll probably want a link when we have one.
+ device is capable of displaying applications written using Sky.
+
+2. Enable developer mode on your device by visiting ``Settings > About phone``
+ and tapping the ``Build number`` field five times.
eseidel 2015/03/02 22:51:52 We might need to link to an external guide.
+
+3. Enable ``USB debugging`` in ``Settings > Developer options``.
eseidel 2015/03/02 22:51:52 Again, possibly an external guide.
+
+Set up your computer
+--------------------
+
+1. Install the ``adb`` tool from the Android SDK.
+ - Mac: ``brew install android-platform-tools``
+ - Linux: ``sudo apt-get install android-tools-adb``
+
+2. Download the Sky framework:
+ a. ``curl -O https://domokit.github.io/sky-sdk.tgz``
+ b. ``tar -xvzf sky-sdk.tgz``
+
+3. Using a USB cable, plug your phone into your computer. If prompted on your
+ device, authorize your computer to access your device.
+
+Running a Sky application
+-------------------------
+
+1. ``/path/to/sky-sdk/run myapp.sky && adb logcat``
eseidel 2015/03/02 22:51:52 Probably a different name than run, but works for
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698