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

Documentation improvements #8

Merged
merged 2 commits into from
Jul 16, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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).