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

Linux
^^^^^

#. Install recent versions of ``g++``, ``make`` and ``ccache``.

#. Install Python 3.8 or later, and then install Mys using ``pip3``.

   .. code-block:: text

      pip3 install mys

#. Run ``mys`` to make sure it was installed successfully.

   .. code-block:: text

      mys

macOS
^^^^^

#. Install recent versions of ``ccache`` and ``pkg-config`` using
   ``brew``.

#. Install Python 3.8 or later, and then install Mys using ``pip``.

   .. code-block:: text

      pip3 install mys

#. Run ``mys`` to make sure it was installed successfully.

   .. code-block:: text

      mys

Windows
^^^^^^^

#. Install `Cygwin`_. Required packages are ``gcc-g++``, ``make``,
   ``python38``, ``python38-pip``, ``python38-devel`` and ``ccache``.

#. Start Cygwin and install Mys.

   .. code-block:: text

      python -m pip install mys

#. Run ``mys`` to make sure it was installed successfully.

   .. code-block:: text

      mys

.. _Cygwin: https://www.cygwin.com/