Quickstart Cli
==================

This guide will help you install the necessary software and dependencies for the project.

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

Before you begin, ensure you have met the following requirements:

- You have a Windows/Linux/Mac machine.
- You have Python 3.6 or higher installed.

Steps
-----

Example usage:

.. code-block:: bash
    
    image-transformer [--help] [-g {hexagonal,square,triangle}] [-p {random,average,frequent}] [-s SIZE] image_path

**Note:** for more details about all the available params use the following command: ``image-transformer --help``.


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

If you encounter any issues during installation, please refer to the project's README file or open an issue on the project's `GitHub page <https://github.com/raideno/image-transformer>`_.