==============
Scotland PYard
==============


.. image:: https://img.shields.io/badge/License-MIT-brightgreen.svg
        :target: https://opensource.org/licenses/MIT

.. image:: https://img.shields.io/pypi/v/ScotlandPYard.svg
        :target: https://pypi.python.org/pypi/ScotlandPYard

.. image:: https://img.shields.io/travis/AhmadZakaria/ScotlandPYard.svg
        :target: https://travis-ci.org/AhmadZakaria/ScotlandPYard

.. image:: https://readthedocs.org/projects/scotlandpyard/badge/?version=latest
        :target: https://ScotlandPYard.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/AhmadZakaria/ScotlandPYard/shield.svg
     :target: https://pyup.io/repos/github/AhmadZakaria/ScotlandPYard/
     :alt: Updates


A python implementation of the board game "Scotland Yard"


* Free software: MIT license
* Documentation: https://ScotlandPYard.readthedocs.io.


Features
--------

* Simple interface
* Colored edges according to ticket type
* Stubs for future AI implementations

To Do
-----
* Implement a good AI agent
* Finish the Gameplay

Credits
---------

* This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
* Some of the icons used are made by `Freepik <http://www.freepik.com>`_ from `www.flaticon.com <https://www.flaticon.com/>`_, licensed by `CC 3.0 BY <http://creativecommons.org/licenses/by/3.0/>`_
* Some of the icons used are made by `Eucalyp <https://www.flaticon.com/authors/eucalyp>`_ from `www.flaticon.com <https://www.flaticon.com/>`_, licensed by `CC 3.0 BY <http://creativecommons.org/licenses/by/3.0/>`_


.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

