skia2/site/user/download.md
jcgregorio 942262fcb5 First set of minimal docs for the new Markdown server, which will eventually replace https://sites.google.com/site/skiadocs/.
Design of the new Markdown server is documented here:

  https://github.com/google/skia-buildbot/blob/master/doc/README.md

  You can see the server up and running here: http://skiadocs.com:8000/

  This is *reed because it adds a new top level directory to the skia repo.

BUG=skia:

Review URL: https://codereview.chromium.org/835083003
2015-01-05 11:17:27 -08:00

1.9 KiB

How to download Skia

Install gclient and git

Follow the instructions on http://www.chromium.org/developers/how-tos/install-depot-tools to download chromium's depot_tools (which includes gclient ).

depot_tools will also install git on your system, if it wasn't installed already.

Configure git

$ git config --global user.name "Your Name"
$ git config --global user.email you@example.com

Download your tree

$ mkdir skia
$ cd skia
$ gclient config --name . --unmanaged https://skia.googlesource.com/skia.git
$ gclient sync
$ git checkout master

At this point, you have everything you need to build and use Skia! If you want to make changes, and possibly contribute them back to the Skia project, read on...

Making changes

First create a branch for your changes:

$ git checkout --track origin/master -b my_feature master

After making your changes, create a commit

$ git add [file1] [file2] ...
$ git commit

If your branch gets out of date, you will need to update it:

$ git pull --rebase
$ gclient sync

Uploading changes for review

$ git cl upload

You may have to enter a Google Account username and password to authenticate yourself to codereview.chromium.org. A free gmail account will do fine, or any other type of Google account. It does not have to match the email address you configured using git config --global user.email above, but it can.

The command output should include a URL (similar to https://codereview.chromium.org/111893004/ ) indicating where your changelist can be reviewed.

Once your change has received an LGTM ("looks good to me"), you can check the "Commit" box on the codereview page and it will be committed on your behalf.

Once your commit has gone in, you should delete the branch containing your change:

$ git checkout master
$ git branch -D my_feature