From e7ca8ba0f76d175eb89e4cc3aa3aa2743711414e Mon Sep 17 00:00:00 2001 From: weili Date: Fri, 29 Apr 2016 12:04:30 -0700 Subject: Documentation change for Window toolchain setting Add a section about Windows Visual Studio toolchain setting. Also announce we are using the Visual Studio toolchain from depot_tools as default. Review-Url: https://codereview.chromium.org/1891383002 --- README.md | 42 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 38 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 53e1b4b8f5..28f6b2a564 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,14 @@ ## News -As of 2016-02-04, the XFA branch is deprecated. Instead, see the section on -configuration below. +As of 2016-02-04, the XFA branch is deprecated. Instead, see +[the section on configuration](#BuildConfig) below. + +As of 2016-04-28, the Visual Studio toolchain from depot_tools is used as the +default Windows toolchain for Googlers. Please set DEPOT_TOOLS_WIN_TOOLCHAIN=0 +if you need to use the system toolchain. See +[Windows development subsection](#WinDev) for details. + ## Prerequisites @@ -13,6 +19,34 @@ the gclient utilty needed below). Also install Python, Subversion, and Git and make sure they're in your path. +### Windows development + +PDFium uses a similar Windows toolchain as Chromium: + +#### Open source contributors +Visual Studio 2015 Update 2 or later is highly recommended. + +Run `set DEPOT_TOOLS_WIN_TOOLCHAIN=0`, or set that variable in your global +environment. + +Compilation is done through ninja, **not** Visual Studio. + +#### Google employees + +Run: `download_from_google_storage --config` and follow the +authentication instructions. **Note that you must authenticate with your +@google.com credentials**. Enter "0" if asked for a project-id. + +Once you've done this, the toolchain will be installed automatically for +you in [the step](#GenBuild) below. + +The toolchain will be in `depot_tools\win_toolchain\vs_files\`, and windbg +can be found in `depot_tools\win_toolchain\vs_files\\win_sdk\Debuggers`. + +If you want the IDE for debugging and editing, you will need to install +it separately, but this is optional and not needed for building PDFium. + + ## Get the code The name of the top-level directory does not matter. In our examples, we use @@ -27,7 +61,7 @@ gclient sync cd pdfium ``` -## Generate the build files +## Generate the build files We use the GYP library to generate the build files. @@ -46,7 +80,7 @@ on Linux, sln files on Windows, and xcodeproj files on Mac. To do so, set the GYP\_GENERATORS environment variable appropriately (e.g. "make", "msvs", or "xcode") before running the above command. -### Selecting build configuration +### Selecting build configuration PDFium may be built either with or without JavaScript support, and with or without XFA forms support. Both of these features are enabled by -- cgit v1.2.3