Skip to content

Commit

Permalink
docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
riffm committed Aug 1, 2011
1 parent 1d0384c commit 3ceae5a
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.rst
Expand Up @@ -28,6 +28,8 @@ mint

- utils_

- CLI_


.. _about:

Expand Down Expand Up @@ -534,4 +536,32 @@ Html helpers
- ``utils.scripts``
- ``utils.link``


.. _CLI:

----------------------
Command Line Interface
----------------------

``mint`` has a CLI. To list available options use ``--help`` flag::

% python -m mint --help
Usage: mint.py [options] [template]

Options:
-h, --help show this help message and exit
-c, --code Show only python code of compiled template.
-t, --tokenize Show tokens stream of template.
-r N, --repeat=N Try to render template N times and display average time
result.
-p, --pprint Turn pretty print on.
-m, --monitor Monitor current directory and subdirectories for changes
in mint files. And render corresponding html files.

CLI works in two modes:

- rendering
- monitoring


That's all folks!

0 comments on commit 3ceae5a

Please sign in to comment.