############
Installation
############

Currently, `XML2VHDL` is hosted on a public :term:`SKAO` :term:`Github`. When
using :term:`Poetry` to manage :term:`Python` dependencies, the following entry 
can be added to `pyproject.toml`.

.. literalinclude:: /example_code/pyproject.toml
   :language: toml
   :start-at: [tool.poetry.group.xml2vhdl]

.. note::
   It is recommended to run `XML2VHDL` within a :term:`Python` `Virtual Environment`.

#######
Running
#######

.. code-block:: console

   xml2vhdl --bus_library axi4_lib --slave_library XML_LINK_LIB --input_folder ./xml --relative_output_path ../generated


.. asciinema:: ../../asciicinema/demo/demo.cast
   :autoPlay: true
   :loop: true
   :fit: width


Help Message
############

The help message for `XML2VHDL` is shown below.

.. code-block:: console

   xml2vhdl -h


.. asciinema:: ../../asciicinema/demo/help.cast
   :autoPlay: true
   :loop: false
   :fit: width