Commits

Jerónimo Albi  committed 0ebbb29

Added some notes to README and a TODO item

  • Participants
  • Parent commits 4937489

Comments (0)

Files changed (2)

 
 ``INI`` style files are used to know which files will be minified, set some
 global options and also to know which files will be joined before
-minimization.
+minification.
 
 A good starting point to get familiar with Shrink config file format is to
 read the example shrink config file. To create an example file run::
 Minimize css and js files
 =========================
 
-To minimize all files, run::
+To minify all files, run::
 
   $ shrink -f example_shrink.cfg all
 
 This will use ``yuicompressor.jar`` and the ``example_shrink.cfg`` file in
 current directory to compress all files.
 
-In case that minimzation is not desired for all files, is also possible to
-minimize individual files, or a group of files (See `Section groups`_), by
+In case that minification is not desired for all files, is also possible to
+minify individual files, or a group of files (See `Section groups`_), by
 using the name(s) of each section instead of ``all`` as argument.
 
 To list available sections, run::
 Sometime can be desirable to reload modified static files without increasing
 application version. In these cases the hash can be used as request parameter
 instead of version number.
+
+Deployment notes
+================
+
+It can happen your application stop working or have unespected results when
+it is deployed with minified css and javascript files.
+Many times some of these problems are is easy avoid by having present the
+following notes during ``shrink.cfg`` setup:
+
+ * The order of the source files in each config section must be the same as
+   the one in your HTML templates.
+ * CSS files normally contains URLs which are relative to the location of
+   the file where they are declared. So for these cases the location for
+   destination file must be the same as the one for source files.
+   Some javascript files might define some path or URL that might also be
+   relative to a file location.
+ * Check that all files wich are NOT minified are being included in your
+   HTML template.
   - Add cssmin support https://github.com/zacharyvoase/cssmin
   - Add jsmin support http://pypi.python.org/pypi/jsmin
 * Add tox for a proper interpreter version testing
+* Add regular expression support for sections (applied before minification)