Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(257)

Unified Diff: README.md

Issue 1412453004: Add some community and testing info to README.md. (Closed) Base URL: https://pdfium.googlesource.com/pdfium.git@master
Patch Set: Created 5 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
diff --git a/README.md b/README.md
index b94589f8bfeff8f019e6f9fbd17e938a140b706c..a032f4eac49e76638ca087811f7d7c9e79c7d05d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Building PDFium
+# PDFium
## Prerequisites
@@ -8,10 +8,6 @@ the gclient utilty needed below).
Also install Python, Subversion, and Git and make sure they're in your path.
-Optionally, you may want to install the [Ninja](http://martine.github.io/ninja/)
-build system (recommended) rather than using your platform-specific build
dsinclair 2015/10/15 23:53:58 Ninja is shipped in depot_tools, so they should, i
Tom Sepez 2015/10/16 00:09:55 ok
Lei Zhang 2015/10/16 00:14:12 Yep. I may have shipped a few ninja binaries. :)
-system.
-
## Get the code
```
@@ -23,17 +19,17 @@ gclient sync
## Generate the build files
-Now we use the GYP library to generate the build files.
+We use the GYP library to generate the build files.
At this point, you have two options. The first option is to use the [Ninja]
-(http://martine.github.io/ninja/) build system. This is the default as of
-mid-September, 2015. Previously, the second option was the default. Most PDFium
-developers use Ninja, as does our [continuous build system]
+(http://martine.github.io/ninja/) build system (also included with the
+depot_tools checkout). This is the default as of mid-September, 2015.
+Previously, the second option (platform-specific build files) was the default.
+Most PDFium developers use Ninja, as does our [continuous build system]
(http://build.chromium.org/p/client.pdfium/).
-On Windows: `build\gyp_pdfium
-` For all other platforms: `build/gyp_pdfium
-`
+ * On Windows: `build\gyp\_pdfium`
+ * For all other platforms: `build/gyp\_pdfium`
The second option is to generate platform-specific build files, i.e. Makefiles
on Linux, sln files on Windows, and xcodeproj files on Mac. To do so, set the
@@ -43,32 +39,46 @@ GYP\_GENERATORS environment variable appropriately (e.g. "make", "msvs", or
## Building the code
If you used Ninja, you can build the sample program by: `ninja -C out/Debug
-pdfium_test
-` You can build the entire product (which includes a few unit tests) by: `ninja
--C out/Debug
-`
+pdfium\_test` You can build the entire product (which includes a few unit
+tests) by: `ninja -C out/Debug`.
If you're not using Ninja, then building is platform-specific.
-On Linux: `make pdfium_test
-`
-
-On Mac, open build/all.xcodeproj
-
-On Windows, open build\all.sln
+ * On Linux: `make pdfium\_test`
Lei Zhang 2015/10/16 00:14:12 Just drop pdfium_test ? "make" by itself builds a
dsinclair 2015/10/16 00:41:26 I don't have a linux box to check at the moment. I
+ * On Mac: `open build/all.xcodeproj`
Tom Sepez 2015/10/16 00:09:55 nit: Is this code or a description of an action? s
dsinclair 2015/10/16 00:41:25 open is a program on osx. So, open build/all.xcode
+ * On Windows: open build\all.sln
## 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
-formats). For example: `out/Debug/pdfium_test --ppm path/to/myfile.pdf
-`
+formats). For example: `out/Debug/pdfium\_test --ppm path/to/myfile.pdf`. Note
+that this will write output images to `path/to/myfile.pdf.<n>.ppm`.
+
+## Testing
+
+There are currently three test suites that can be run:
Lei Zhang 2015/10/16 00:14:12 There's more...
dsinclair 2015/10/16 00:41:26 Acknowledged.
+
+ * pdfium\_unittests
+ * pdfium\_embeddertests
+ * testing/tools/run_corpus_tests.py
Tom Sepez 2015/10/16 00:09:55 There's actually more than that. See what the bot
dsinclair 2015/10/16 00:41:25 Done.
+
+The corpus tests can have different pixel output on the various platforms so
+they are most reliable when executed by the bots.
## Waterfall
The current health of the source tree can be found at
http://build.chromium.org/p/client.pdfium/console
+## Community
+
+There are several mailings that are setup:
+
+ * [PDFium](https://groups.google.com/forum/#!forum/pdfium)
+ * [PDFium Reviews](https://groups.google.com/forum/#!forum/pdfium-reviews)
Lei Zhang 2015/10/16 00:14:12 Do you want to mention pdfium-reviews and pdfium-b
dsinclair 2015/10/16 00:41:25 Done.
+ * [PDFium Bugs](https://groups.google.com/forum/#!forum/pdfium-bugs)
+
## Bugs
We will be using this
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698