From d20e3880234a35a558237316cac5d70fff4224bc Mon Sep 17 00:00:00 2001 From: Tom Sepez Date: Wed, 12 Apr 2017 16:06:25 -0700 Subject: Tidy build instructions Removes a suggestion to run "gn gen" before that step can succeed. Also removes some stray HTML preventing a heading from rendering. Wordsmith a few other sections. Change-Id: I77630e683a24a793a96ecbbd53ba13525cf79e64 Reviewed-on: https://pdfium-review.googlesource.com/4130 Reviewed-by: Wei Li Reviewed-by: Lei Zhang Commit-Queue: Tom Sepez --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bd2e40d15e..1f2b923683 100644 --- a/README.md +++ b/README.md @@ -58,15 +58,12 @@ gclient sync cd pdfium ``` -## Generate the build files +## Generate the build files We use GN to generate the build files and -[Ninja](http://martine.github.io/ninja/) (also included with the depot\_tools -checkout) to execute the build files. - -``` -gn gen -``` +[Ninja](http://martine.github.io/ninja/) +to execute the build files. Both of these are included with the +depot\_tools checkout. ### Selecting build configuration @@ -90,17 +87,20 @@ pdf_is_standalone = true # Set for a non-embedded build. is_component_build = false # Disable component build (must be false) clang_use_chrome_plugins = false # Currently must be false. -use_sysroot = false # Currently must be false on Linux. +use_sysroot = false # Currently must be false on Linux, but entirely omitted on windows. ``` Note, you must set `pdf_is_standalone = true` if you want the sample applications like `pdfium_test` to build. -When complete the arguments will be stored in `/args.gn`. +When complete the arguments will be stored in `/args.gn`, and +GN will automatically use the new arguments to generate build files. +Should your files fail to generate, please double-check that you have set +use\_sysroot as indicated above. ## Building the code -If you used Ninja, you can build the sample program by: +You can build the sample program by: `ninja -C /pdfium_test` You can build the entire product (which includes a few unit tests) by: `ninja -C `. -- cgit v1.2.3