jdhp-tictactoe 0.4.dev0

=========
TicTacToe
=========

Copyright (c) 2016 Jérémie DECOCK (www.jdhp.org)

* Web site: http://www.jdhp.org/software_en.html#tictactoe-py
* Online documentation: http://jdhp-tictactoe-py.readthedocs.org
* Source code: https://github.com/jeremiedecock/tictactoe-py
* Issue tracker: https://github.com/jeremiedecock/tictactoe-py/issues
* TicTacToe on PyPI: https://pypi.python.org/pypi/jdhp-tictactoe


Description
===========

Play the classic Tic-Tac-Toe game.

Note:

This project is still in beta stage, so the API is not finalized yet.


Dependencies
============

* Python >= 3.0

.. _install:

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

Gnu/Linux
---------

You can install, upgrade, uninstall TicTacToe with these commands (in a
terminal)::

pip install --pre jdhp-tictactoe
pip install --upgrade jdhp-tictactoe
pip uninstall jdhp-tictactoe

Or, if you have downloaded the TicTacToe source code::

python3 setup.py install

.. There's also a package for Debian/Ubuntu::
..
.. sudo apt-get install jdhp-tictactoe

Windows
-------

.. Note:
..
.. The following installation procedure has been tested to work with Python
.. 3.4 under Windows 7.
.. It should also work with recent Windows systems.

You can install, upgrade, uninstall TicTacToe with these commands (in a
`command prompt`_)::

py -m pip install --pre jdhp-tictactoe
py -m pip install --upgrade jdhp-tictactoe
py -m pip uninstall jdhp-tictactoe

Or, if you have downloaded the TicTacToe source code::

py setup.py install

MacOSX
-------

.. Note:
..
.. The following installation procedure has been tested to work with Python
.. 3.5 under MacOSX 10.9 (*Mavericks*).
.. It should also work with recent MacOSX systems.

You can install, upgrade, uninstall TicTacToe with these commands (in a
terminal)::

pip install --pre jdhp-tictactoe
pip install --upgrade jdhp-tictactoe
pip uninstall jdhp-tictactoe

Or, if you have downloaded the TicTacToe source code::

python3 setup.py install


Documentation
=============

* Online documentation: http://jdhp-tictactoe-py.readthedocs.org
* API documentation: http://jdhp-tictactoe-py.readthedocs.org/en/latest/api.html


Example usage
=============

TODO


Bug reports
===========

To search for bugs or report them, please use the TicTacToe Bug Tracker at:

https://github.com/jeremiedecock/tictactoe-py/issues


License
=======

This project is provided under the terms and conditions of the `MIT License`_.


.. _MIT License: http://opensource.org/licenses/MIT

.. _TicTacToe: http://www.jdhp.org/software_en.html#tictactoe-py