Skip to content
This repository has been archived by the owner on Sep 17, 2018. It is now read-only.

Commit

Permalink
Edit README for readability.
Browse files Browse the repository at this point in the history
  • Loading branch information
tav committed Oct 16, 2012
1 parent 1f606a2 commit 90236cc
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,17 @@ The default support includes:

* Compiling CoffeeScript/TypeScript source files into JavaScript.

* Minifying through UglifyJS/UglifyJS2 -- including constant folding support.
* Minifying with UglifyJS/UglifyJS2 -- including constant folding support.

* Generating Source Maps for TypeScript and minified JavaScript sources.
* Generating source maps for TypeScript and minified JavaScript sources.

* Compiling and minifying CSS from Less, SASS, SCSS and Stylus source files.

* Generating variants of the same stylesheet for both internationalisation
* Generating variants of the same stylesheet for internationalisation
(flipping left to right).

* Embedding image/font resources as ``data:`` URIs within CSS stylesheets to
minimise latency -- just replace ``url()`` entries with ``embed()`` entries
in your source css/less/sass/scss/stylus files.
minimise latency.

* Concatenating multiple source files into one file to minimise the number of
HTTP requests.
Expand Down Expand Up @@ -103,15 +102,19 @@ file, e.g.
css.compressed: false
js.compressed: false

You can even control which config options gets used by specifying the
``--profile`` parameter. This will override default values with the values
specified for the given profile. So, in the above example, specifying
``--profile dev`` will use all the ``profile.dev`` options.
To take advantage of the embedding within stylesheets just replace ``url()``
entries with ``embed()`` entries in your source stylesheet files -- whether
that is less, sass, scss, stylus or plain old CSS.

Whilst you are developing, you can use the ``--watch`` command-line parameter
to tell ``assetgen`` to monitor file changes and rebuild all appropriate
files. Watch also monitors changes to the ``assetgen.yaml`` file, so you can
update the config without having to restart ``assetgen``.
You can control which config options gets used by specifying the ``--profile``
parameter. This will override default values with the values specified for the
given profile. So, in the above example, specifying ``--profile dev`` will use
all the ``profile.dev`` options.

And, whilst you are developing, you can use the ``--watch`` command-line
parameter to tell ``assetgen`` to monitor file changes and rebuild all
appropriate files. Watch also monitors changes to the ``assetgen.yaml`` file,
so you can update the config without having to restart ``assetgen``.

During development, one often runs ``--watch`` with a dev profile, e.g.

Expand Down

0 comments on commit 90236cc

Please sign in to comment.