diff options
| author |  commit-bot@chromium.org <commit-bot@chromium.org@2bbb7eff-a529-9590-31e7-b0007b416f81> | 2014-01-24 19:25:39 +0000 |
|---|---|---|
| committer | commit-bot@chromium.org <commit-bot@chromium.org@2bbb7eff-a529-9590-31e7-b0007b416f81> | 2014-01-24 19:25:39 +0000 |
| commit | 8f2201144945be6693dd4954c2cc89e085f14ef8 (patch) | |
| tree | 25793b5517bb1c96241740d4d100db0521fea1a0 /docs | |
| parent | 9ebcac54635cde63110d73ad7c43d70772e7872f (diff) | |
Add a sample doc in markdown format.
BUG=skia:
R=epoger@google.com, halcanary@google.com, borenet@google.com, jcgregorio@google.com, bungeman@google.com
Author: mtklein@google.com
Review URL: https://codereview.chromium.org/146943002
git-svn-id: http://skia.googlecode.com/svn/trunk@13175 2bbb7eff-a529-9590-31e7-b0007b416f81
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/quickstart.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 0000000000..554ea48836 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,35 @@ +Skia Quickstart Guide +===================== + +This guide assumes you've got `gclient`, `git`, and `ninja` on your path. + +1. First, create a directory to hold Skia: + * `mkdir skia` + * `cd skia` +2. Then checkout Skia: + * `gclient config --name . https://skia.googlesource.com/skia.git` + * `gclient sync` +3. Create our Ninja build files from our Gyp meta-build files. You only need + to rerun this when you sync or change a `.gyp` file. + * `GYP_GENERATORS=ninja ./gyp_skia` +4. Now, let's build Skia. There are a few options: + * `ninja -C out/Debug`: no optimization, asserts enabled + * `ninja -C out/Release`: optimization, asserts disabled + * `ninja -C out/Coverage`: no optimization, asserts enabled, code coverage generated +5. Run some tests: + * `out/Debug/tests`: runs unit tests from tests/ + * `out/Debug/dm`: runs golden master tests from gm/ +6. Make some changes: + * `git checkout -b my-new-feature origin/master` + * `vim src/...` + * `git commit -am "Changes for my new feature."` + * `vim tests/...` + * `git commit --amend -a` + * `ninja -C out/Debug && out/Debug/tests && out/Debug/dm && echo ok` +7. Rebase your change onto the latest Skia code: + * `git pull --rebase` + * `ninja -C out/Debug && out/Debug/tests && out/Debug/dm && echo ok` +8. Upload your change and send it out for review: + * `git cl upload -r my-skia-reviewer@google.com -s` + * `git cl web` +9. Go through code review, get an LGTM, submit using the checkbox on the code review page. |