From 20878718a94211066c98531c267771f263bb13c8 Mon Sep 17 00:00:00 2001 From: Soeren Peters <peters@irmb.tu-bs.de> Date: Tue, 12 Dec 2023 12:54:37 +0000 Subject: [PATCH] Update Readme: add badges and citation text. --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a72346933..9824439cc 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@  -[](https://doi.org/10.5281/zenodo.10283049) + [](https://www.repostatus.org/#active) [](https://git.rz.tu-bs.de/irmb/VirtualFluids/-/releases) +[](https://git.rz.tu-bs.de/irmb/VirtualFluids/-/commits/main) VirtualFluids (VF) is a research code developed at the Institute for Computational Modeling in Civil Engineering (iRMB). The code is a Computational Fluid Dynamics (CFD) solver based on the Lattice Boltzmann Method (LBM) for turbulent, thermal, multiphase and multicomponent flow problems as well as for multi-field problems such as Fluid-Structure-interaction including distributed pre- and postprocessing capabilities for simulations with more than 100 billion degrees of freedom. - ## Documentation You can find more information about the code in the [wiki](https://git.rz.tu-bs.de/irmb/virtualfluids/-/wikis/home). -The wiki contains information about the installation, usage and development of VirtualFluids. It also contains information about how to [contribute](https://git.rz.tu-bs.de/irmb/virtualfluids/-/wikis/Contributing) to the code. +The wiki contains information about the installation, usage and development of VirtualFluids. + +## License +VirtualFluids is licensed under the terms and conditions of the GNU General Public License (GPL) version 3 or - at your option - any later. + +See the file [COPYING.txt](COPYING.txt) for copying permissions. For a full list of contributors see [AUTHORS.md](AUTHORS.md). If you notice that a contributor is missing on the list, please contact us or open a merge request adding the name. + +## How to cite +VirtualFluids is research software and developed at research institutions. +You can cite specific releases via Zenodo: [](https://doi.org/10.5281/zenodo.10283049). + +## Contributing +Contributions are highly welcome. Please review the [contribution guidelines](https://git.rz.tu-bs.de/irmb/virtualfluids/-/wikis/Contributing) before opening issues and merge requests. + ## Known Issues If you notice any problems on your platform, please report an [issue](https://git.rz.tu-bs.de/irmb/virtualfluids/-/issues/new). - -## Authors -A list of the developers of VirtualFluids is available [here](AUTHORS.md). -- GitLab