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

Prerequisites
-------------

- Python 3.11 or higher
- Poetry (for dependency management)
- Git (for cloning the repository)

Quick Start
-----------

1. Clone the repository:

   .. code-block:: bash

      git clone https://github.com/Danweel/LatticeLang.git
      cd LatticeLang

2. Install dependencies with Poetry:

   .. code-block:: bash

      poetry install

3. Activate the environment:

   .. code-block:: bash

      poetry shell

4. Run the application:

   .. code-block:: bash

      poetry run python -m latticelang

Development Installation
------------------------

For contributors who want to modify the source code:

.. code-block:: bash

   poetry install --with dev,docs


See the :ref:`troubleshooting` section below.

.. note::
   This section will expand as we gather common installation issues from users.

.. _troubleshooting:

Troubleshooting
---------------

If you encounter issues during installation:

1. Ensure you are using Python 3.11 or higher.
2. Verify your Poetry installation is up to date.
3. Check that your virtual environment is activated.

For more help, please open an issue on our `GitHub repository <https://github.com/Danweel/LatticeLang/issues>`_.