<commit_before>redtape
-----------

<commit_msg>add more readme<commit_after>redtape
-------

``redtape`` is a focused documentation generator that uses `github flavored markdown`_
to generate simple, attractive HTML documents.  It automatically integrates with
`twitter bootstrap`_ and features simple, attractive styling.  It is inspired by
`d`_, but attempts to have a simple interface while still allowing users to style
and control their output documents to a high degree of customization.

.. _github flavored markdown: http://github.github.com/github-flavored-markdown/
.. _twitter bootstrap: http://twitter.github.com/bootstrap
.. _d: http://stevelosh.com/projects/d/

installing
----------

If you are on linux or OSX, you can use `pip`_ to install::

    > pip install redtape

Which will install redtape and its dependencies.

.. _pip: http://www.pip-installer.org/en/latest/index.html

usage
-----

To use, run ``rt`` on a document or directory full of documents.  It will
create html files for every markdown file (``.md``, ``.mdown``, or 
``.markdown`` extensions)::

    > rt mydocument.md
    > rt documentation/

By default, ``rt`` assumes you have set up a location to serve the files from
which have the assets that ``rt`` links into these documents.  If you can't be
bothered to do that, you have two options.  You can embed all of the assets
used in the resultant document::

    > rt --embed mydocument.md

You can ask ``rt`` to put a copy of its assets in a directory called
``./assets``::

    > rt --create-assets

You can run a simple HTTP server and look at them, fully styled::

    > python -m SimpleHTTPServer

{'fraction_non_alphanumeric': 0.10792682926829268, 'fraction_numerical': 0.0, 'mean_word_length': 3.495890410958904, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4953283', 'n_tokens_mistral': 473, 'n_tokens_neox': 455, 'n_words': 213}