From d7d72296d52a609d36d01464f582c8c9d7c0b1ed Mon Sep 17 00:00:00 2001 From: Francois-Xavier KOWALSKI Date: Wed, 24 Oct 2012 14:58:36 +0200 Subject: ENYO-1259: Bootplate doc & script update to use deploy.js - removal of the `tools/` folder (now embedded into `$enyo/tools`). - `tools/README.md` is now `deploy.md` & is updated to use `deploy.js` - this commit demands that this Enyo branch is merged first into `enyojs/enyo` https://github.com/enyojs/enyo/tree/ENYO-1259 Enyo-DCO-1.0-Signed-off-by: Francois-Xavier KOWALSKI --- tools/README.md | 62 -------------------------- tools/deploy.bat | 130 ------------------------------------------------------- tools/deploy.sh | 92 --------------------------------------- tools/minify.bat | 7 --- tools/minify.sh | 11 ----- tools/package.js | 5 --- 6 files changed, 307 deletions(-) delete mode 100644 tools/README.md delete mode 100644 tools/deploy.bat delete mode 100755 tools/deploy.sh delete mode 100644 tools/minify.bat delete mode 100755 tools/minify.sh delete mode 100644 tools/package.js (limited to 'tools') diff --git a/tools/README.md b/tools/README.md deleted file mode 100644 index c2923c6..0000000 --- a/tools/README.md +++ /dev/null @@ -1,62 +0,0 @@ -# Minification and Deployment -## Understanding and Using Minification - -Enyo comes with a minification tool based on NodeJS and UglifyJS. - -This tool can be used to compress the framework, other libraries, and applications, and will keep load order intact as well as correct url paths in css. - -### Why compress? - -Compressing enyo apps greatly reduces load times of appliactions, as well as reducing overall code size. - -This way, you can be very verbose in the documentation of your source code, without that impacting the performance of your application in production. - -### What is compressed - -For enyo, the libraries, and your code: **external assets such as images will not be copied or moved**. - -Instead, the CSS url paths are fixed up to reference the new path from the build location. - -### How to compress - -To compress your application, you must enter the `minify` folder and run one of the scripts. -- On Windows, just double click on `minify.bat` -- On Mac and Linux, run `minify.sh` - -Both scripts will run the minification tool located in `enyo/tools/minify`, and make a build of enyo, then a build of your app. - -Any libraries referenced in your `package.js` manifest will be built into your app's built code. - -**NOTE:** The `package.js` file inside the `minify` folder is mandatory, and only references your app's `package.js` to keep paths correct. Do not modify this. - -### What comes out? - -After running the minify script, a new folder `build` will be located next to your `source` directory. - -In it will be 4 files: -- enyo.css -- enyo.js -- app.css -- app.js - -These files will be loaded in the given order by `index.html`. - -## Deployment - -The deploy scripts included here will make a production ready copy of your application, and copy it into a packeagable folder. - -### How to run - -Just execute the platform specific `deploy` script. - -### What comes out? - -The output of the `deploy` scripts will minify your appliaction, and copy the necessary files into `deploy/--