<commit_before>==================================================================
font-awesome-customize - Create custom versions of `Font Awesome`_
==================================================================

font-awesome-customize is a command-line tool written in Python that generates
custom versions of the iconic `Font Awesome`_ with just the icons you need.
If you only require a small subset of the icons provided by Font Awesome,
custom versions safe precious bandwidth.

The code is heavily based on `icnfnt`_ by <NAME> and <NAME>ohns.
The corresponding `icnfnt.com`_ web interface is very convenient for one-time use.
However, as your web application grows and requires more icons,
remembering which icons you need and selecting them by hand may be a hassle.
Instead, you may prefer automating the process with font-awesome-customize.


Quick Start
-----------

On Ubuntu, install the dependencies using

.. code:: bash
    sudo apt-get install python-pip python-fontforge

Then, install font-awesome-customize from `PyPI`_ using

.. code:: bash
    sudo pip install font-awesome-customize

To a custom version of `Font Awesome`_ containing the icons
`music` and `search` in the folder `fontawesome-custom`, use

.. code:: bash
	font-awesome-customize -o fontawesome-custom music search

.. _Font Awesome: http://fortawesome.github.io/Font-Awesome/
.. _icnfnt: https://github.com/johnsmclay/icnfnt
.. _icnfnt.com: http://www.icnfnt.com/
.. _PyPI: https://pypi.python.org/pypi/font-awesome-customize/0.1<commit_msg>Fix reStructuredText syntax in README<commit_after>font-awesome-customize - Create custom versions of `Font Awesome`_
==================================================================

font-awesome-customize is a command-line tool written in Python that generates
custom versions of the iconic `Font Awesome`_ with just the icons you need.
If you only require a small subset of the icons provided by Font Awesome,
custom versions safe precious bandwidth.

The code is heavily based on `icnfnt`_ by <NAME> and <NAME>.
The corresponding `icnfnt.com`_ web interface is very convenient for one-time use.
However, as your web application grows and requires more icons,
remembering which icons you need and selecting them by hand may be a hassle.
Instead, you may prefer automating the process with font-awesome-customize.


Quick Start
-----------

On Ubuntu, install the dependencies using::

    sudo apt-get install python-pip python-fontforge

Then, install font-awesome-customize from `PyPI`_ using::

    sudo pip install font-awesome-customize

To a custom version of `Font Awesome`_ containing the icons
``music`` and ``search`` in the folder ``fontawesome-custom``, use::

	font-awesome-customize -o fontawesome-custom music search

.. _Font Awesome: http://fortawesome.github.io/Font-Awesome/
.. _icnfnt: https://github.com/johnsmclay/icnfnt
.. _icnfnt.com: http://www.icnfnt.com/
.. _PyPI: https://pypi.python.org/pypi/font-awesome-customize/0.1
{'fraction_non_alphanumeric': 0.15147453083109919, 'fraction_numerical': 0.0013404825737265416, 'mean_word_length': 4.517560073937154, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, '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': '1583543', 'n_tokens_mistral': 878, 'n_tokens_neox': 806, 'n_words': 328}