.. highlight:: shell

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


Docker
------
.. todo::
    document how to run as3ninja with docker


Python Package
--------------

.. todo::
    publication to pypi (installation via pip) is planned with a future release


..    Stable release
..    --------------
..
..    To install AS3 Ninja, run this command in your terminal:
..
..    .. code-block:: console
..
..        $ pip install as3ninja
..
..    This is the preferred method to install AS3 Ninja, 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 AS3 Ninja can be downloaded from the `Github repo`_.
..
..    You can either clone the public repository:
..
..    .. code-block:: console
..
..        $ git clone git://github.com/simonkowallik/as3ninja
..
..    Or download the `tarball`_:
..
..    .. code-block:: console
..
..        $ curl  -OL https://github.com/simonkowallik/as3ninja/tarball/master
..
..    Once you have a copy of the source, you can install it with:
..
..    .. code-block:: console
..
..        $ python setup.py install
..
..
..    .. _Github repo: https://github.com/simonkowallik/as3ninja
..    .. _tarball: https://github.com/simonkowallik/as3ninja/tarball/master
..
