Update README.md.
- Better explain what depot_tools provides.
- Clarify where to run build/install-build-deps.sh from.
- Mention out directories need to be named out/foo by convention.
- Mention pdfium_test --help.
- Mention Chromium code coverage reports.
- Fix the link to Chromium's security bug template.
- Clarify PDFium uses a different Gerrit instance, not a different tool
entirely.
- Replace "CL" with "change" since not everyone knows CL stands for
Change List.
- Update URLs.
Change-Id: Ib460745008ce28d8c0e584ddd2b2caa5ce505fee
Reviewed-on: https://pdfium-review.googlesource.com/c/49311
Reviewed-by: Tom Sepez <tsepez@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
diff --git a/README.md b/README.md
index 574e032..2b6dfaf 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,10 @@
## Prerequisites
-Get the chromium depot tools via the instructions at
-http://www.chromium.org/developers/how-tos/install-depot-tools (this provides
-the gclient utility needed below).
+Get the Chromium depot\_tools via the
+[instructions](https://www.chromium.org/developers/how-tos/install-depot-tools).
+This provides the gclient utility needed below and many other tools needed for
+PDFium development.
Also install Python, Subversion, and Git and make sure they're in your path.
@@ -14,13 +15,14 @@
PDFium uses the same build tool as Chromium:
#### Open source contributors
-Please refer to [Chromium's Visual Studio set up](https://chromium.googlesource.com/chromium/src/+/master/docs/windows_build_instructions.md#visual-studio)
+Please refer to
+[Chromium's Visual Studio set up](https://chromium.googlesource.com/chromium/src/+/master/docs/windows_build_instructions.md#visual-studio)
for requirements and instructions on build environment configuration.
Run `set DEPOT_TOOLS_WIN_TOOLCHAIN=0`, or set that variable in your global
environment.
-Compilation is done through ninja, **not** Visual Studio.
+Compilation is done through Ninja, **not** Visual Studio.
### CPU Architectures supported
@@ -63,7 +65,8 @@
cd pdfium
```
-Additional build dependencies need to be installed by running:
+Additional build dependencies need to be installed by running the following from
+the `pdfium` directory.
```
./build/install-build-deps.sh
@@ -71,8 +74,7 @@
## Generate the build files
-We use GN to generate the build files and
-[Ninja](http://martine.github.io/ninja/)
+We use GN to generate the build files and [Ninja](https://ninja-build.org/)
to execute the build files. Both of these are included with the
depot\_tools checkout.
@@ -84,6 +86,8 @@
Configuration is done by executing `gn args <directory>` to configure the build.
This will launch an editor in which you can set the following arguments.
+By convention, `<directory>` should be named `out/foo`, and some tools / test
+support code only works if one follows this convention.
A typical `<directory>` name is `out/Debug`.
```
@@ -123,9 +127,10 @@
## Running the sample program
The pdfium\_test program supports reading, parsing, and rasterizing the pages of
-a .pdf file to .ppm or .png output image files (windows supports two other
+a .pdf file to .ppm or .png output image files (Windows supports two other
formats). For example: `<directory>/pdfium_test --ppm path/to/myfile.pdf`. Note
that this will write output images to `path/to/myfile.pdf.<n>.ppm`.
+Run `pdfium_test --help` to see all the options.
## Testing
@@ -155,6 +160,11 @@
Code coverage reports for PDFium can be generated in Linux development
environments. Details can be found [here](/docs/code-coverage.md).
+Chromium provides code coverage reports for PDFium
+[here](https://chromium-coverage.appspot.com/). PDFium is located in
+`third_party/pdfium` in Chromium's source code.
+This includes code coverage from PDFium's fuzzers.
+
## Profiling
Valgrind and other profiling tools do not work correctly with the standard build
@@ -164,8 +174,8 @@
## Waterfall
-The current health of the source tree can be found at
-https://ci.chromium.org/p/pdfium/g/main/console
+The current health of the source tree can be found
+[here](https://ci.chromium.org/p/pdfium/g/main/console).
## Community
@@ -180,9 +190,9 @@
## Bugs
We use this
-[bug tracker](https://code.google.com/p/pdfium/issues/list), but for security
-bugs, please use [Chromium's security bug template]
-(https://code.google.com/p/chromium/issues/entry?template=Security%20Bug)
+[bug tracker](https://bugs.chromium.org/p/pdfium/issues/list), but for security
+bugs, please use
+[Chromium's security bug template](https://bugs.chromium.org/p/chromium/issues/entry?template=Security%20Bug)
and add the "Cr-Internals-Plugins-PDF" label.
## Contributing code
@@ -192,7 +202,7 @@
as much as possible. The main exceptions are:
1. Code has to conform to the existing style and not Chromium/Google style.
-2. PDFium uses a different tool for code reviews, and credentials for
-the tool need to be generated before uploading a CL.
+2. PDFium uses a different Gerrit instance for code reviews, and credentials for
+this Gerrit instance need to be generated before uploading changes.
3. PDFium is currently holding at C++11 compatibility, rejecting features that
are only present in C++14 (onto which Chromium is now slowly moving).
