Chromium Code Reviews| Index: site/user/quick/windows.md |
| diff --git a/site/user/quick/windows.md b/site/user/quick/windows.md |
| index fa00376064aae2bb492bfe24f1eaff769711f627..bf47ab7ac5c8cf2f9284a3abb908c79c8e6c05d5 100644 |
| --- a/site/user/quick/windows.md |
| +++ b/site/user/quick/windows.md |
| @@ -6,97 +6,132 @@ Prerequisites |
| Make sure the following have been installed: |
| - * Visual C++ 2013 Express or later, available for free |
| - * http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-8 |
| - |
| - * Chromium depot_tools |
| - * http://www.chromium.org/developers/how-tos/depottools |
| - * git |
| - * Either use the mysygit installed by depot_tools |
| - * Or install msys git: http://msysgit.github.io/ yourself |
| - * Python 2.7.x (if you're not planning to use cygwin) |
| - * available for free download at http://www.python.org/download/releases/ |
| - * make sure the installer changes your %PATH% environment variable to include the directory with the "python.exe" binary |
| - * Cygwin (optional, but useful if you want to use git) |
| - * Download from http://cygwin.org/setup.exe |
| - * use any mirror you like; http://lug.mtu.edu works well |
| - * Cygwin installs a minimum of options. Add these packages if they aren't already selected: |
| - * Devel git |
| - * Devel subversion |
| - * Editors vim |
| - * to fix arrows in insert, copy /usr/share/vim/vim73/vimrc_example.vim to ~/.vimrc |
| - * Net ca-certificates |
| - * Python python |
| - * Utils patch |
| - * Utils util-linux |
| - * set the windows envionment variable CYGWIN to nodosfilewarning |
| +* [Visual C++ 2013 Express or later, available for |
| + free](https://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-8) |
| + |
| +* [Chromium depot_tools](https://www.chromium.org/developers/how-tos/depottools) |
| + |
| +* Git |
| + - Either use the mysygit installed by depot_tools |
| + - Or [install git-for-windows |
| + yourself](https://git-for-windows.github.io/). |
| + |
| +* Python 2.7.x (if you're not planning to use cygwin) |
| + - available for free download at |
| + [python.org](https://www.python.org/download/releases/) |
| + - make sure the installer changes your %PATH% environment variable |
| + to include the directory with the "python.exe" binary |
| + |
| +* Cygwin (**optional**, but useful if you want to use git) |
| + - Download from https://www.cygwin.com/setup-x86.exe or |
| + https://www.cygwin.com/setup-x86_64.exe |
| + - use any mirror you like; http://lug.mtu.edu works well |
|
hcm
2015/11/13 05:03:45
Capitalize "use"
hal.canary
2015/11/13 12:21:45
done
|
| + - Cygwin installs a minimum of options. Add these packages if they |
| + aren't already selected: |
| + + Devel git |
| + + Devel subversion |
| + + Editors vim |
| + * to fix arrows in insert, copy |
| + `/usr/share/vim/vim73/vimrc_example.vim` to `~/.vimrc` |
| + + Net ca-certificates |
| + + Python python |
| + + Utils patch |
| + + Utils util-linux |
| + - set the windows envionment variable CYGWIN to nodosfilewarning |
|
hcm
2015/11/13 05:03:45
Capitalize "set"
hal.canary
2015/11/13 12:21:45
done
|
| Check out the source code |
| ------------------------- |
| -see https://skia.org/user/download |
| +Follow the instructions [here](../download) for downloading the Skia source. |
| -Generate Visual Studio projects |
| -------------------------------- |
| +Gyp Generators on Windows |
| +------------------------- |
| -We use the open-source gyp tool to generate Visual Studio projects (and |
| +We use the open-source Gyp tool to generate Visual Studio projects (and |
| analogous build scripts on other platforms) from our multi-platform "gyp" |
| files. |
| -You can generate the Visual Studio projects by running gyp_skia, as follows: |
| +Three Gyp generators are used on Windows: |
| - (setup GYP_GENERATORS, see just below) |
| - cd %SKIA_CHECKOUT_DIR% |
| - python gyp_skia |
| +* `ninja` - Run ninja yourself, without VisualStudio project files, |
| + |
| +* `msvs-ninja` - Develop from a fully-integrated Visual Studio. |
| + Gyp generates Visual-Studio-compatible project files that still |
| + ultimately build using ninja |
| + |
| +* `msvs` - Use Visual Studio's own (slower) build system |
| -If you like to develop from a fully-integrated Visual Studio, set |
| -GYP_GENERATORS=ninja,msvs-ninja before running gyp_skia to generate |
| -Visual-Studio-compatible project files that still ultimately build using ninja, |
| -or set it to msvs to use Visual Studio's own (slower) build system. If you are |
| -comfortable with and prefer running ninja yourself, GYP_GENERATORS=ninja is |
| -considerably faster than the other two options. |
| +To choose which ones to use, set the `GYP_GENERATORS` environment |
| +variable to a comma-delimited list of generators before running |
| +sync-and-gyp. The default value for `GYP_GENERATORS` is |
| +`ninja,msvs-ninja`. For example to enable the `ninja` and `msvs` |
| +generators: |
| + |
| +<a name="env"></a>Setting Enviroment Variables in Windows CMD.EXE |
| +----------------------------------------------------------------- |
| + |
| + cd %SKIA_CHECKOUT_DIR% |
| + SET "GYP_GENERATORS=ninja,msvs" |
| + python bin/sync-and-gyp |
| + SET "GYP_GENERATORS=" |
| Build and run tests from the command line |
| ----------------------------------------- |
| - ninja -C out\Debug dm |
| + ninja -C out/Debug dm |
| out\Debug\dm |
| -Normally you should run tests in Debug mode (SK_DEBUG is defined, and debug |
| -symbols are included in the binary). If you would like to build the Release |
| -version instead: |
| - |
| - ninja -C out\Release dm |
| - out\Release\dm |
| +See [this page for running Skia tests on all desktop](./desktop) |
| Build and run tests in the Visual Studio IDE |
| -------------------------------------------- |
| - * Generate the Visual Studio project files by running gyp_skia as described above |
| - * Open a File Explorer window pointing at the %SKIA_CHECKOUT_DIR%\out\gyp directory |
| - * Double-click on dm.sln to start Visual Studio and load the project |
| - * When Visual Studio starts, you may see an error dialog stating that "One or more projects in the solution were not loaded correctly"... but there's probably nothing to worry about. |
| - * In the "Solution Explorer" window, right-click on the "dm" project and select "Set as StartUp Project". |
| - * In the "Debug" menu, click on "Start Debugging" (or just press F5). If you get a dialog saying that the project is out of date, click on "Yes" to rebuild it. |
| - * Once the build is complete, you should see console output from the tests in the "Output" window at lower right. |
| +1. Generate the Visual Studio project files by running `sync-and-gyp` as |
| + described above |
| + |
| +2. Open a File Explorer window pointing at the |
| + `%SKIA_CHECKOUT_DIR%\out\gyp` directory |
| + |
| +3. Double-click on dm.sln to start Visual Studio and load the project |
| + |
| +4. When Visual Studio starts, you may see an error dialog stating that |
| + "One or more projects in the solution were not loaded |
| + correctly"... but there's probably nothing to worry about. |
| + |
| +5. In the "Solution Explorer" window, right-click on the "dm" project |
| + and select "Set as StartUp Project". |
| + |
| +6. In the "Debug" menu, click on "Start Debugging" (or just press |
| + F5). If you get a dialog saying that the project is out of date, |
| + click on "Yes" to rebuild it. |
| + |
| +7. Once the build is complete, you should see console output from the |
| + tests in the "Output" window at lower right. |
| Build and run SampleApp in Visual Studio |
| ---------------------------------------- |
| - * Generate the Visual Studio project files by running gyp_skia as described above |
| - * Open a File Explorer window pointing at the %SKIA_INSTALLDIR%\trunk\out\gyp directory |
| - * Double-click on SampleApp.sln |
| - * When Visual Studio starts, you may see an error dialog stating that "One or more projects in the solution were not loaded correctly"... but there's probably nothing to worry about. |
| - * In the "Debug" menu, click on "Start Debugging" (or just press F5). If you get a dialog saying that the project is out of date, click on "Yes" to rebuild it. |
| - * Once the build is complete, you should see a window with various example graphics. To move through the sample app, use the following keypresses: |
| - * right-arrow key: cycle through different test pages |
| - * left-arrow key: cycle through rendering methods for each test page |
| - * other keys are defined in SampleApp.cpp’s SampleWindow::onHandleKey() and SampleWindow::onHandleChar() methods |
| +1. Generate the Visual Studio project files by running `sync-and-gyp` |
| + as described above |
| + |
| +2. Open a File Explorer window pointing at the |
| + `%SKIA_INSTALLDIR%\trunk\out\gyp` directory |
| + |
| +3. Double-click on SampleApp.sln |
| -Build and run nanobench (performance testbench) from the command line |
| ---------------------------------------------------------------------- |
| +4. When Visual Studio starts, you may see an error dialog stating |
| + that "One or more project s in the solution were not loaded |
| + correctly"... but there's probably nothing to worry about. |
| -Since nanobench tests performance, it usually makes more sense to run it in Release mode. |
| +5. In the "Debug" menu, click on "Start Debugging" (or just press |
| + F5). If you get a dialog saying that the project is out of date, |
| + click on "Yes" to rebuild it. |
| - ninja -C out\Release nanobench |
| - out\Release\nanobench |
| +6. Once the build is complete, you should see a window with various |
| + example graphics. To move through the sample app, use the |
| + following keypresses: |
| + - right-arrow key: cycle through different test pages |
| + - left-arrow key: cycle through rendering methods for each test page |
| + - other keys are defined in SampleApp.cpp’s |
| + SampleWindow::onHandleKey() and SampleWindow::onHandleChar() |
| + methods |