From c52ce7db41a69252148750fb497d8c8e05dcef0c Mon Sep 17 00:00:00 2001 From: munechika-koyo Date: Wed, 5 Nov 2025 11:18:47 +0100 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9D=20Fix=20wrong=20description=20?= =?UTF-8?q?in=20Get=20started=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/intro.md b/docs/source/intro.md index b41db3c..4caaae0 100644 --- a/docs/source/intro.md +++ b/docs/source/intro.md @@ -2,7 +2,7 @@ # 🚀 Get Started -This page gives a quick overview of how to get started with `cherab-imas`, and how to use it within Docutils and Sphinx. +This page gives a quick overview of how to get started with `cherab-imas`, including installation instructions and a simple example script. ## Installation From 60a35e068a343a7578f9fc927968a376560bbf96 Mon Sep 17 00:00:00 2001 From: munechika-koyo Date: Wed, 5 Nov 2025 11:25:44 +0100 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9D=20Update=20PyPI=20publish=20ba?= =?UTF-8?q?dge=20URL=20and=20enhance=20module=20description=20for=20clarit?= =?UTF-8?q?y?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 34e1a1b..48f0340 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,14 @@ [pypi]: https://pypi.org/project/cherab-imas/ [pypi-badge]: https://img.shields.io/pypi/v/cherab-imas?label=PyPI&logo=pypi&logoColor=gold&style=flat-square [pypi-publish]: https://github.com/cherab/imas/actions/workflows/deploy-pypi.yml -[pypi-publish-badge]: https://img.shields.io/github/actions/workflow/status/cherab/imas/deploy-pypi.yml?style=flat-square&label=PyPI%20Publish&logo=github +[pypi-publish-badge]: https://img.shields.io/github/actions/workflow/status/cherab/imas/deploy-pypi.yml?event=release&style=flat-square&logo=github&label=PyPI%20Publish [python-badge]: https://img.shields.io/pypi/pyversions/cherab-imas?logo=Python&logoColor=gold&style=flat-square --- -`cherab` add-on module for IMAS (Integrated Modelling & Analysis Suite). +[`cherab`](https://github.com/cherab/core) add-on module for **IMAS** (Integrated Modelling & Analysis Suite). -This module enables the creation of `cherab`'s functional objects (e.g. plasma, observers, meshes, etc.) from IMAS IDS (Interface Data Structures). +This module enables the creation of `cherab`'s functional objects (e.g. plasma, observers, meshes, etc.) from IMAS IDSs (Interface Data Structures).