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

Commit e3f2ea2

Browse files
committed
Merge pull request #8 from collinjackson/docs
Documentation improvements
2 parents 2497e5d + 7320c4d commit e3f2ea2

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,18 @@ The Sky engine repository gladly accepts contributions via GitHub pull requests:
6262
* `git push origin name_of_your_branch`
6363
* Go to `https://github.com/<your_name_here>/sky_engine` and click the
6464
"Compare & pull request" button
65+
66+
You must complete the
67+
[Contributor License Agreement](https://cla.developers.google.com/clas).
68+
You can do this online, and it only takes a minute.
69+
If you've never submitted code before, you must add your (or your
70+
organization's) name and contact info to the [AUTHORS](AUTHORS) file.
71+
72+
Running tests
73+
-------------
74+
75+
Tests are only supported on Linux currently.
76+
77+
* ``sky/tools/test_sky --debug``
78+
* This runs the tests against ``//out/Debug``. If you want to run against
79+
``//out/Release``, omit the ``--debug`` flag.

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
Sky
22
===
3+
4+
Sky is a new way to build high performance, cross platform mobile apps.
5+
More specifically, Sky is a rendering engine, a scripting engine, an
6+
(optional) framework, and a (optional) set of Material Design widgets.
7+
Sky is optimized for today's, and tomorrow's, mobile devices. We are focused
8+
on low-latency input, high frame rates, and we are purely mobile first.
9+
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.
12+
13+
For information about contributing to Sky, please see
14+
[CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)