.. highlight:: shell

============
Installation
============

Stable Release
==============

To install generic_lexer, run this command in your terminal::

   $ pip install generic-lexer

This is the preferred method to install generic_lexer, as it will always
install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide:
   http://docs.python-guide.org/en/latest/starting/installation/


From Sources
============

The sources for generic_lexer can be downloaded from the `Github repo`_.

You can either clone the public repository::

   $ git clone git://github.com/Cerberus1746/generic_lexer

Or download the `tarball`_::

   $ curl -OJL https://github.com/Cerberus1746/generic_lexer/tarball/master

Once you have a copy of the source, you can install it with::

   $ python setup.py install

.. _Github repo: https://github.com/Cerberus1746/generic_lexer
.. _tarball: https://github.com/Cerberus1746/generic_lexer/tarball/master