Skip to content

Commit

Permalink
Documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Collin Jackson committed Jul 16, 2015
1 parent edd9b31 commit f2c5a03
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,18 @@ The Sky engine repository gladly accepts contributions via GitHub pull requests:
* `git push origin name_of_your_branch`
* Go to `https://github.com/<your_name_here>/sky_engine` and click the
"Compare & pull request" button

You must complete the
[Contributor License Agreement](https://cla.developers.google.com/clas).
You can do this online, and it only takes a minute.
If you've never submitted code before, you must add your (or your
organization's) name and contact info to the ``AUTHORS``(AUTHORS) file.

Running tests
-------------

Tests are only supported on Linux currently.

* ``sky/tools/test_sky --debug``
* This runs the tests against ``//out/Debug``. If you want to run against
``//out/Release``, omit the ``--debug`` flag.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
Sky
===

Sky is a new way to build high performance, cross platform mobile apps.
More specifically, Sky is a rendering engine, a scripting engine, an
(optional) framework, and a (optional) set of Material Design widgets.
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 contributing to Sky, please see
[CONTRIBUTING.md](CONTRIBUTING.md).

0 comments on commit f2c5a03

Please sign in to comment.