===============================
{{ cookiecutter.project_name }}
===============================

{{ cookiecutter.project_short_description}}


Features
--------

* TODO


Usage
-----

Launching the app
~~~~~~~~~~~~~~~~~

`Kivy`_ is compatible with Python 2 as well as Python 3::

    cd {{ cookiecutter.repo_name }} 
    python main.py

Running the testsuite
~~~~~~~~~~~~~~~~~~~~~

Run its testsuite either with Python3::

    cd {{ cookiecutter.repo_name }} 
    python -m unittest discover

Or with `nose`_::

    cd {{ cookiecutter.repo_name }} 
    nosetests

Or with `py.test`_::

    cd {{ cookiecutter.repo_name }}
    py.test

Deploying to Android
~~~~~~~~~~~~~~~~~~~~

You can easily run the app on Android by using the `Kivy Launcher`_.


License
-------

Distributed under the terms of the `MIT license`_, {{cookiecutter.repo_name}} free and open source software


Issues
------

Report bugs at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/issues.


.. _`Kivy Launcher`: http://kivy.org/docs/guide/packaging-android.html#packaging-your-application-for-the-kivy-launcher
.. _`Kivy`: https://github.com/kivy/kivy
.. _`MIT License`: http://opensource.org/licenses/MIT
.. _`nose`: https://github.com/nose-devs/nose/
.. _`py.test`: http://pytest.org/latest/

=============================
{{cookiecutter.project_name}}
=============================

{{cookiecutter.project_short_description}}


Features
--------

* TODO


Usage
-----

Launching the app
~~~~~~~~~~~~~~~~~

`Kivy`_ is compatible with Python 2 as well as Python 3::

    cd {{cookiecutter.repo_name}}
    python main.py

Running the testsuite
~~~~~~~~~~~~~~~~~~~~~

Run its testsuite either with Python3::

    cd {{cookiecutter.repo_name}}
    python -m unittest discover

Or with `nose`_::

    cd {{cookiecutter.repo_name}}
    nosetests

Or with `py.test`_::

    cd {{cookiecutter.repo_name}}
    py.test

Deploying to Android
~~~~~~~~~~~~~~~~~~~~

You can easily run the app on Android by using the `Kivy Launcher`_.


License
-------

Distributed under the terms of the `MIT license`_, {{cookiecutter.repo_name}} free and open source software


Issues
------

Report bugs at https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_name}}/issues.


.. _`Kivy Launcher`: http://kivy.org/docs/guide/packaging-android.html#packaging-your-application-for-the-kivy-launcher
.. _`Kivy`: https://github.com/kivy/kivy
.. _`MIT License`: http://opensource.org/licenses/MIT
.. _`nose`: https://github.com/nose-devs/nose/
.. _`py.test`: http://pytest.org/latest/

Remove whitespaces in cookie vars in app readme
Remove whitespaces in cookie vars in app readme
