NOTE: This is a general template that you can use for a project README.md. Except for the mandatory sections, use only those sections that suit your use case but keep the proposed section order.

Mandatory sections:

• Overview
• Prerequisites, if there are any requirements regarding hard- or software
• Installation
• Contributing - do not change this!
• Code of Conduct - do not change this!
• Licensing - do not change this!

Provide a description of the project's functionality.

If it is an example README.md, describe what the example illustrates.

List all the prerequisites that are necessary for the project. Include the required hardware, software, and any other dependencies. Required software:

• Python 3.12.*
• Poetry 1.8.3

Explain the steps to install your project. If there are multiple installation options, mention the recommended one and include others in a separate document. Create an ordered list for each installation task.

If it is an example README.md, describe how to build, run locally, and deploy the example. Format the example as code blocks and specify the language, highlighting where possible. Explain how you can validate that the example ran successfully. For example, define the expected output or commands to run which check a successful deployment.

Add subsections (H3) for better readability.

We use Poetry to manage dependencies in the project. Poetry is a powerful tool for managing dependencies in Python projects. Here's a quick guide on how to add, remove, and update dependencies using Poetry.

To install all dependencies listed in the pyproject.toml file, you can use the poetry install command:

poetry install

To update a specific dependency to its latest version, you can use the poetry update command followed by the name of the package:

poetry update {package_name}

To add a new dependency to your project, you can use the poetry add command followed by the name of the package you want to add:

poetry add {package_name}

Or, with an exact version:

poetry add {package_name}@{version}

To remove a dependency from your project, you can use the poetry remove command followed by the name of the package:

poetry remove {package_name}

You can create a virtual environment for the project by navigating to the project's root directory and run:

poetry install

This will create a new virtual environment and install the project's dependencies.

To activate the virtual environment, use poetry shell. This will start a new shell session with the virtual environment activated:

poetry shell

You can now run Python and any installed packages in this shell, and they will use the virtual environment. To exit the virtual environment, simply exit command.

Poetry automatically uses the virtual environment when you run commands like poetry run. For example, to run a Python script:

poetry run python src/main.py

Remember to run these commands in the root directory of your project where the pyproject.toml file is located.

Pycharm users can also use the virtual environment created by Poetry. To do this follow the guides.

Explain how to use the project. You can create multiple subsections (H3). Include the instructions or provide links to the related documentation.

Add instructions on how to develop the project or example. It must be clear what to do and, for example, how to trigger the tests so that other contributors know how to make their pull requests acceptable. Include the instructions or provide links to related documentation.

Release testing and release creation are two separate processes. You can find the release testing documentation in the Contributor Readme file.

See the Contributing Rules.

See the Code of Conduct document.

See the license file.