Skip to content

Commit

Permalink
Add a basic CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abarth committed Jul 16, 2015
1 parent 01ff5c3 commit d974d65
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Contributing to Sky Engine
==========================

Getting the code
----------------

To get the code:

1. Fork https://github.com/domokit/sky_engine into your own GitHub account.
2. [Download depot_tools](http://www.chromium.org/developers/how-tos/install-depot-tools)
and make sure it is in your path.
3. Create a `.gclient` file in an empty directory with the following contents:

```
solutions = [
{
"managed": False,
"name": "src",
"url": "[email protected]:<your_name_here>/sky_engine.git",
"custom_deps": {},
"deps_file": "DEPS",
"safesync_url": "",
},
]
target_os = ["android"]
```

4. `svn ls https://dart.googlecode.com/` and accept the certificate permanently.
5. `gclient sync`
6. `cd src`
7. `git remote add upstream [email protected]:domokit/sky_engine.git`
8. `./build/install-build-deps.sh`

Building the code
-----------------

1. `./mojo/tools/mojob gn`
2. `ninja -C out/Debug`

Contributing code
-----------------

The Sky engine repository gladly accepts contributions via GitHub pull requests.

0 comments on commit d974d65

Please sign in to comment.