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

Requirements
------------

Tessella targets **Python 3.12 to 3.14** and depends on:

- ``pygame-ce``
- ``numpy``
- ``pyperclip``

Installing
----------

.. code-block:: bash

   pip install tessella

Setting up for development
----------------------------

To work on Tessella itself, clone the repository and install it in
editable mode inside a virtual environment:

.. code-block:: bash

   git clone https://github.com/cuaitz/tessella.git
   cd tessella

   python -m venv venv

   # Windows
   venv\Scripts\activate

   # Linux / macOS
   source venv/bin/activate

   pip install -e .

Editable installs pick up code changes immediately, without reinstalling.

Building this documentation
------------------------------

Docs are built with `Sphinx <https://www.sphinx-doc.org/>`_ and the
`Read the Docs theme <https://sphinx-rtd-theme.readthedocs.io/>`_, pulling
the API reference straight from Tessella's docstrings:

.. code-block:: bash

   pip install -r docs/requirements.txt
   cd docs
   make html   # Windows: make.bat html

The generated site lands at ``docs/build/html/index.html``.

Next steps
----------

Continue with :doc:`quickstart` to open your first Tessella window, or
jump into :doc:`tutorial` for a complete walkthrough.