Rat-vcpkg
=========

.. image::
    ../_static/figs/rat-vcpkg/banner-1.svg
   :alt: Project-Rat-Extras Rat-vcpkg banner
   :align: left
   :class: img-bottom-padding
   :width: 100 %

\- *Rejoice, for there is still hope in compiling across all platforms!*

-----

Rat-vcpkg_ defines a `vcpkg registry`_: a collection of `vcpkg ports`_
to simplify and streamline the compilation of Project-Rat_ group C++
libraries for magnetic simulations across multiple platforms with
vcpkg_ as a package manager to reuse them across projects.

.. topic:: Windows VS Linux

    vcpkg_ is cross-platform but it is however more interesting
    when compiling on **Windows** as C++ compilation and toolchain
    can require a lot more work compared to a Linux environment.

    **This documentation will therefore emphasize on Windows** since
    it is the primary target for the vcpkg_ compilation toolchain.

.. seealso::
    
    For a more direct approach utilizing vcpkg_ default ports to
    compile Rat C++ libraries: `Installation sequence for Rat on Windows <https://gitlab.com/Project-Rat/rat-documentation/-/blob/master/installation/wininstall.md?ref_type=heads>`__
    on Rat-Docs_.

    For a containerized approach to compile Rat C++ libraries on Linux:
    :doc:`../repo-rat-containers/index`.
    
    For a more direct approach to compile Rat C++ libraries on Linux:
    `Installation (Linux) <https://gitlab.com/Project-Rat/rat-documentation#installation-linux>`__
    on Rat-Docs_.

.. Rat-vcpkg table of contents
.. toctree::
   :maxdepth: 2
   :caption: RAT-VCPKG CONTENTS

   setup
   build_and_use
   about_vcpkg_ports
   about_vcpkg_registries
   checks

.. Links
.. _Project-Rat: https://gitlab.com/project-rat
.. _Rat-Docs: https://gitlab.com/project-rat/rat-documentation
.. _Rat-vcpkg: https://gitlab.com/project-rat-extras/rat-vcpkg
.. _vcpkg: https://vcpkg.io/en/
.. _vcpkg ports: https://learn.microsoft.com/en-us/vcpkg/concepts/ports
.. _vcpkg registry: https://learn.microsoft.com/en-us/vcpkg/concepts/registries