From abd2346e2a563b2b2842e18de333c27c5c8ef0e7 Mon Sep 17 00:00:00 2001 From: Jonas Jenwald Date: Tue, 19 Jan 2021 12:38:04 +0100 Subject: [PATCH] Put less emphasis on "ES5"/"ES6" in the README and other documentation - Don't explicitly mention "ES5" in https://mozilla.github.io/pdf.js/getting_started/#download, since that's no longer accurate. As-is, this will more than likely give users the wrong impression regarding our *actual* browser support. - Reword the "Getting the Code"-section of the README, since an ES6-compatible browser is no longer sufficient for development purposes given our usage of modern ECMAScript features. - Update the "Building PDF.js"-section of the README, to explicitly mention both the `gulp generic` and `gulp generic-es5` commands. Hopefully this will help reduce *some* user confusion, but we should perhaps also consider changing the "-es5"-suffix in our build-scripts and build-folders. (That would however require coming up with a "better" suffix, which might not be trivial.) --- README.md | 8 ++++++-- docs/contents/getting_started/index.md | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5a93f825c..b954b023f 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ and then you can open: + http://localhost:8888/web/viewer.html -Please keep in mind that this requires an ES6 compatible browser; refer to [Building PDF.js](https://github.com/mozilla/pdf.js/blob/master/README.md#building-pdfjs) for usage with older browsers. +Please keep in mind that this requires a modern and fully up-to-date browser; refer to [Building PDF.js](https://github.com/mozilla/pdf.js/blob/master/README.md#building-pdfjs) for non-development usage of the PDF.js library. It is also possible to view all test PDF files on the right side by opening: @@ -83,7 +83,11 @@ viewer, run: $ gulp generic -This will generate `pdf.js` and `pdf.worker.js` in the `build/generic/build/` directory. +If you need to support older browsers, run: + + $ gulp generic-es5 + +This will generate `pdf.js` and `pdf.worker.js` in the `build/generic/build/` directory (respectively `build/generic-es5/build/`). Both scripts are needed but only `pdf.js` needs to be included since `pdf.worker.js` will be loaded by `pdf.js`. The PDF.js files are large and should be minified for production. diff --git a/docs/contents/getting_started/index.md b/docs/contents/getting_started/index.md index b3328734a..63fcbabe9 100644 --- a/docs/contents/getting_started/index.md +++ b/docs/contents/getting_started/index.md @@ -49,7 +49,7 @@ Before downloading PDF.js please take a moment to understand the different layer
-

Prebuilt (ES5-compatible)

+

Prebuilt (for older browsers)

Includes the generic build of PDF.js and the viewer.