From db533b5655e4f4f34448befc8f1cd8fbe1e3f670 Mon Sep 17 00:00:00 2001 From: Jeff Parsons Date: Tue, 13 Sep 2016 16:08:31 -0700 Subject: [PATCH] Added some info to the README about the state of the JavaScript-based Closure Compiler --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 15518c74f..db21b197a 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,7 @@ OS X users may also need to preface this command with `sudo`: Now you can run `grunt` anywhere within the PCjs project to build an updated version. If no command-line arguments are specified, `grunt` runs the "default" task defined by the project's [Gruntfile](Gruntfile.js); that task runs Google's [Closure Compiler](https://developers.google.com/closure/compiler/) if any of the target files (eg, pcx86.js -or pcx86-dbg.js in the [/versions](versions/) directory) are out-of date. +or pcx86-dbg.js in the [versions](/versions/) directory) are out-of date. To ensure consistent compilation results, a copy of the Closure Compiler has been checked into the [/bin](bin/) folder. This version of Closure Compiler, in turn, requires Java v7 or later. Use the following @@ -219,7 +219,7 @@ client or server components use Java. Newer versions of the Closure Compiler should work as well, and at some point, a newer version will be checked into the project. -### Building with the JavaScript-based Closure Compiler (and Gulp) +### Building with Gulp (and the JavaScript-based Closure Compiler) I've started dabbling with [Gulp](http://gulpjs.com/), but the current [gulpfile](gulpfile.js) has a long way to go before it can replace the [Gruntfile](Gruntfile.js). At the moment, all Gulp builds is a single emulation module with @@ -231,7 +231,11 @@ Here's what I installed to get Gulp working: npm install --save-dev gulp gulp-concat gulp-rename gulp-replace gulp-header gulp-foreach gulp-wrapper run-sequence npm install --save-dev google-closure-compiler-js -Running `gulp` should build a new `pcx86.js` in the [/versions](versions/) directory. +Running `gulp` should build a new `pcx86.js` in the [versions](/versions/) directory. However, +please consider Gulp support (and anything built with Gulp) as **experimental** until further notice. +The [JavaScript-based Closure Compiler](https://github.com/google/closure-compiler-js) may not be stable either; +for example, they removed *output_wrapper* support almost immediately after documenting it on their +[blog](https://developers.googleblog.com/2016/08/closure-compiler-in-javascript.html). Using PCjs ---