From 8337f96da73fda041604f61a0996d1ca0bd9674e Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Sat, 2 Mar 2024 02:17:26 +0900 Subject: [PATCH] Update badges in README to use for-the-badge style (#202) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 1afae8de..71ee8abb 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ -🚧 scikit-gmsh is in the pre-alpha stage the interface could be subject to important changes soon. +🚧 scikit-gmsh is in the pre-alpha stage. The interface could be subject to significant changes soon. # scikit-gmsh -[![Documentation Status](https://readthedocs.org/projects/scikit-gmsh/badge/?version=latest)](https://scikit-gmsh.readthedocs.io/en/latest/?badge=latest) - [](https://github.com/pyvista/scikit-gmsh#--------) > Scikit for Gmsh to generate 3D finite element mesh. +[![Documentation Status](https://readthedocs.org/projects/scikit-gmsh/badge/?version=latest&style=for-the-badge)](https://scikit-gmsh.readthedocs.io/en/latest/?badge=latest) +[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-2.1-4baaaa.svg?style=for-the-badge)](https://github.com/pyvista/scikit-gmsh/blob/main/CODE_OF_CONDUCT.md) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black) +[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=for-the-badge&labelColor=ef8336)](https://pycqa.github.io/isort/) +[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=for-the-badge)](https://github.com/astral-sh/ruff) +[![NEP29](https://raster.shields.io/badge/follows-NEP29-orange.png?style=for-the-badge)](https://numpy.org/neps/nep-0029-deprecation_policy.html) +[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0) + Contributions _very welcome_ but first see [Contributing](#contributions). Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. @@ -28,8 +35,6 @@ Enjoying scikit-gmsh? Show your support with a [Github star](https://github.com/ - [Installation](#installation) - [Developer](#developer) - [Usage](#usage) -- [Contributions](#contributions) -- [License](#license) @@ -140,17 +145,3 @@ clipped = mesh.clip(origin=(0.0, 0.0, 0.0), normal=(0.0, 0.0, 1.0), crinkle=True

- -## Contributions - -[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-2.1-4baaaa.svg)](https://github.com/pyvista/scikit-gmsh/blob/main/CODE_OF_CONDUCT.md) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) -[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pyvista/scikit-gmsh/main.svg)](https://results.pre-commit.ci/latest/github/pyvista/scikit-gmsh/main) -[![NEP29](https://raster.shields.io/badge/follows-NEP29-orange.png)](https://numpy.org/neps/nep-0029-deprecation_policy.html) -[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) - -## License - -[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)