.. kamzik3 documentation master file, created by
   sphinx-quickstart on Thu Aug  5 10:54:26 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. |Kamzik icon| image:: ../kamzik3/kamzik.ico
  :width: 50
  :alt: Server icon

.. |Unicorn icon| image:: ../kamzik3/kamzik_client.ico
  :width: 50
  :alt: Client icon

|Kamzik icon|  Welcome to kamzik3's documentation!
==================================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. include:: ../README.rst

See the full :doc:`Changelog<HISTORY>`

Example experiment
==================

Copy the content of the `/example` folder into a writable directory of your choice.
Choose that directory as a working directory.

|Kamzik icon| Start the server:

 ``python server.py``

|Unicorn icon| Start the client:

 ``python client.py``

Optionally, you can start the listener:

 ``python listener.py``

Templates for the user interface
================================

Many templates are already available for the user interface. You can modify them using
Qt designer.

.. toctree::
   :maxdepth: 1

   gui_templates.rst

Configuration files
===================

One config file must be provided for each server and another one for the client.

.. toctree::
   :maxdepth: 1

   write_config.rst

API Documentation
=================

Documentation of the modules included in kamzik3.

.. toctree::
   :maxdepth: 1

   modules/index.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`