summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 36 insertions, 3 deletions
diff --git a/README.md b/README.md
index 24fc1f3d7b..89096cd00d 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,13 @@
## 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-15, Visual Studio toolchain from depot_tools will be used as the
+default. Set DEPOT_TOOLS_WIN_TOOLCHAIN=0 if you need to use system toolchain.
+See [Windows development subsection](#WinDev) for details.
+
## Prerequisites
@@ -13,6 +18,34 @@ the gclient utilty needed below).
Also install Python, Subversion, and Git and make sure they're in your path.
+###<a name="WinDev"></a> Windows development
+
+PDFium uses 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 Step 3, below (near the end of the step).
+
+The toolchain will be in `depot_tools\win_toolchain`, and windbg can be
+found in `depot_tools\win_toolchain\vs2013_files\win8sdk\Debuggers`.
+
+If you want the IDE for debugging and editing, you will need to install
+it separately, but this is optional and not needed to build PDFium.
+
+
## Get the code
The name of the top-level directory does not matter. In our examples, we use
@@ -46,7 +79,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
+###<a name="BuildConfig"></a> 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