Add badges to readme (#87)

* docs: add first badges

* docs: update gitlab to github links

* docs: reorganize badges and update links

.github/workflows/documentation.yml → .github/workflows/build_documentation.yml

@@ -1,5 +1,5 @@
 # yamllint disable
-name: documentation
+name: build_documentation
 
 on:
   push:

.github/workflows/tests_local.yml

@@ -1,7 +1,12 @@
 # yamllint disable
 name: tests_local
 
-on: [pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
 
 env:
   # Set TEST_TIMING_OPTION if local test should be timed. Default is off.

CONTRIBUTING.md

@@ -74,5 +74,5 @@ main branch by the QUEENS maintainers. This ensures that the community has a cha
 
 ## :book: Documentation
 We use [Sphinx](https://www.sphinx-doc.org/en/master/#) to generate the
-[QUEENS documentation](https://queens_community.pages.gitlab.lrz.de/queens/docs/).
+[QUEENS documentation](https://queens-py.github.io/queens).
 We believe that documentation is essential and therefore welcome any improvements.

README.md

@@ -7,6 +7,23 @@
 </picture>
 </div>
 
+<div align="center">
+
+[![QUEENS-website](https://img.shields.io/badge/QUEENS-website-5cbbfe?logo=book)](https://www.queens-py.org/)
+[![QUEENS-documentation](https://img.shields.io/badge/QUEENS-documentation-5cbbfe?logo=book)](https://queens-py.github.io/queens)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
+
+</div>
+
+<div align="center">
+
+[![tests-local-main](https://github.com/queens-py/queens/actions/workflows/tests_local.yml/badge.svg?branch=main)](https://github.com/queens-py/queens/actions/workflows/tests_local.yml?query=branch:main)
+[![build-documentation-main](https://github.com/queens-py/queens/actions/workflows/build_documentation.yml/badge.svg?branch=main)](https://github.com/queens-py/queens/actions/workflows/build_documentation.yml?query=branch:main)
+
+</div>
+
 QUEENS (**Q**uantification of **U**ncertain **E**ffects in **En**gineering **S**ystems) is a Python framework for solver-independent multi-query analyses of large-scale computational models.
 
 :chart_with_upwards_trend: **QUEENS** offers a large collection of cutting-edge algorithms for deterministic and probabilistic analyses such as:
@@ -22,10 +39,6 @@ QUEENS (**Q**uantification of **U**ncertain **E**ffects in **En**gineering **S**
 * easy switching between analysis types
 * smooth scaling from laptop to HPC cluster
 
-:globe_with_meridians: **Website**: [queens-py.org](https://www.queens-py.org)
-
-:book: **Documentation**: [queens-py.github.io/queens](https://queens-py.github.io/queens)
-
 ## :rocket: Getting started
 
 >**Prerequisites**: Unix system and environment management system (we recommend [miniforge](https://conda-forge.org/download/))

pyproject.toml

@@ -40,11 +40,11 @@ queens-export-metadata = "queens.utils.cli_utils:gather_metadata_and_write_to_cs
 
 # urls
 [project.urls]
-Homepage = "https://queens_community.pages.gitlab.lrz.de/website/"
-Documentation = "https://queens_community.pages.gitlab.lrz.de/queens/docs/"
-Repository = "https://gitlab.lrz.de/queens_community/queens.git"
-Issues = "https://gitlab.lrz.de/queens_community/queens/-/issues"
-Changelog = "https://gitlab.lrz.de/queens_community/queens/-/blob/main/CHANGELOG.md"
+Homepage = "https://www.queens-py.org"
+Documentation = "https://queens-py.github.io/queens"
+Repository = "https://github.com/queens-py/queens.git"
+Issues = "https://github.com/queens-py/queens/issues"
+Changelog = "https://github.com/queens-py/queens/blob/main/CHANGELOG.md"
 
 # Tools section
 [tool.black]