.. Furax Poker documentation master file, created by
   sphinx-quickstart on Sat May  9 20:45:16 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===========
Furax Poker
===========

Furax Poker is an open source poker HUD (head-up display) application. It
monitors your hand history folder in real time to display statistics about your
opponents. Furax Poker works on Linux and Windows, the only supported poker
room is Winamax but others could easily be added (see
:ref:`dev-getting-started-contributing`).

.. toctree::
   :maxdepth: 3

   user/index
   dev/index
   changelog