<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
<!-- SPDX-FileCopyrightText: Copyright © VirtualFluids Project contributors, see AUTHORS.md in root folder -->

# Documentation

Welcome to the VirtualFluids Documentation!

## Getting Started

We recommend using VirtualFludis with Docker
- <!-- DOXYGEN_MAKE_REF -->[Getting Started with Docker](Getting-Started-with-Docker.md)

If Docker cannot be used, the dependecies for VirtualFluids can also be installed manually directly on your machine:
- <!-- DOXYGEN_MAKE_REF -->[Installing the Dependencies manually](Getting-Started-Not-Using-Docker.md)

 After the installation VirtualFluids can be compiled and executed:
- <!-- DOXYGEN_MAKE_REF -->[Compiling and Running the examples](Build-and-Run.md)

## Development

- <!-- DOXYGEN_MAKE_REF -->[Contributing](../../Contributing.md)
- <!-- DOXYGEN_MAKE_REF -->[Document Code](How-To-Document-Code.md)
- <!-- DOXYGEN_MAKE_REF -->[Debugging in VS Code](Debugging-with-Vscode.md)
- <!-- DOXYGEN_MAKE_REF -->[Unit Tests in VirtualFluids](Unit-Tests.md)
- <!-- DOXYGEN_MAKE_REF -->[Regression Tests](Regression-Tests.md)
- <!-- DOXYGEN_MAKE_REF -->[Release](Release.md)

## Guidelines

- <!-- DOXYGEN_MAKE_REF -->[Coding Guidelines](Coding-Guidelines.md)
- <!-- DOXYGEN_MAKE_REF -->[Direction Scheme](Direction-Scheme.md)
- <!-- DOXYGEN_MAKE_REF -->[Kernel Scheme](Kernel-Scheme.md)