Make stylistic changes to the deployed readme

fortuno-repos · Sep 28, 2024 · 71c9c97 · 71c9c97
1 parent 6737953
commit 71c9c97
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 90 deletions.
diff --git a/devel/fpm-repo/coarray/addons/README.rst b/devel/fpm-repo/coarray/addons/README.rst
@@ -2,31 +2,34 @@
 Fortuno – flextensible unit testing framework for Fortran
 *********************************************************
 
-The **Fortuno** (Fortran Unit Testing Objects) project offers a flexible &
-extensible, object oriented unit testing framework for the Fortran language. It
-puts strong emphasis on the simplicity of the user interface by minimizing the
-amount of boiler plate code when writing unit tests, as well as to modularity
-and extensibility by offering building blocks for customized unit testing
-systems.
-
-This is an automatically deployed version of the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_ for projects building with the
-`Fortran package manager (fpm) <https://fpm.fortran-lang.org/>`_. If you are
-using `fpm <https://fpm.fortran-lang.org/>`_ in your project, add one (and only
-one) of the following repositories as development dependency to your
-``fpm.toml`` manifest file in order to use the Fortuno unit testing framework:
-
-* `<https://github.com/fortuno-repos/fortuno-fpm-serial.git>`_: if you only need
-  the **serial interface** offered by the ``fortuno_serial`` module::
+**Fortuno** (Fortran Unit Testing Objects) is a flexible & extensible,
+object-oriented unit testing framework designed for the Fortran programming
+language. It emphasizes ease of use by minimizing boiler plate code when writing
+tests, while also prioratizing modularity and extensibility. Fortuno provides
+the essential building blocks to help developers create customized unit testing
+solutions.
+
+This repository is an automatically deployed version of the `Fortuno repository
+<https://github.com/fortuno-repos/fortuno>`_ for projects built using the
+`Fortran package manager (fpm) <https://fpm.fortran-lang.org/>`_. For projects
+built with other systems like `CMake <https://cmake.org/>`_ or `Meson
+<https://mesonbuild.com/>`_, you should refer to the `main Fortuno repository
+<https://github.com/fortuno-repos/fortuno>`_.
+
+If your project uses fpm, simply add one (and only one) of the following
+repositories as a development dependency in your ``fpm.toml`` file to integrate
+Fortuno into your unit testing process:
+
+* **Serial interface**: If your project only requires the serial interface from
+  the ``fortuno_serial`` module, add this to your ``fpm.toml``::
 
     [dev-dependencies]
     fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-serial.git" }
 
 
-* `<https://github.com/fortuno-repos/fortuno-fpm-mpi.git>`_: if you also need
-  (additional to the serial one) the **MPI interface** offered by the
-  ``fortuno_mpi`` module. Your project must declare the MPI framework as an
-  additional meta-package dependency::
+* **MPI interface**: If your project requires the MPI interface from the
+  ``fortuno_mpi`` module, add the snippet below to your ``fpm.toml``. You also
+  must declare the metapackage MPI as dependency::
 
       [dependencies]
       mpi = "*"
@@ -35,21 +38,17 @@ one) of the following repositories as development dependency to your
       fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-mpi.git" }
 
 
-* `<https://github.com/fortuno-repos/fortuno-fpm-coarray.git>`_: if you also
-  need (additional to the serial one) the **coarray interface** offered by the
-  ``fortuno_coarray`` module. Your project must be compiled with the right
-  compiler and linker flags enabling coarray features::
+* **Coarray interface**: If your project needs the coarray interface offered by
+  the ``fortuno_coarray`` module, use the following dependency. Ensure your
+  project is compiled with the appropriate compiler and linker flags to enable
+  coarray support::
 
       [dev-dependencies]
       fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-coarray.git" }
 
 
-If your projects uses the `CMake <https://cmake.org/>`_ or the `Meson
-<https://mesonbuild.com/>`_ build systems, you must use the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_ directly.
-
-For documentation, pull requests, issues, etc. refer to the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_.
+For more information, including documentation, issues and pull requests, please
+visit the `Fortuno repository <https://github.com/fortuno-repos/fortuno>`_.
 
 
 License

diff --git a/devel/fpm-repo/mpi/addons/README.rst b/devel/fpm-repo/mpi/addons/README.rst
@@ -2,31 +2,34 @@
 Fortuno – flextensible unit testing framework for Fortran
 *********************************************************
 
-The **Fortuno** (Fortran Unit Testing Objects) project offers a flexible &
-extensible, object oriented unit testing framework for the Fortran language. It
-puts strong emphasis on the simplicity of the user interface by minimizing the
-amount of boiler plate code when writing unit tests, as well as to modularity
-and extensibility by offering building blocks for customized unit testing
-systems.
-
-This is an automatically deployed version of the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_ for projects building with the
-`Fortran package manager (fpm) <https://fpm.fortran-lang.org/>`_. If you are
-using `fpm <https://fpm.fortran-lang.org/>`_ in your project, add one (and only
-one) of the following repositories as development dependency to your
-``fpm.toml`` manifest file in order to use the Fortuno unit testing framework:
-
-* `<https://github.com/fortuno-repos/fortuno-fpm-serial.git>`_: if you only need
-  the **serial interface** offered by the ``fortuno_serial`` module::
+**Fortuno** (Fortran Unit Testing Objects) is a flexible & extensible,
+object-oriented unit testing framework designed for the Fortran programming
+language. It emphasizes ease of use by minimizing boiler plate code when writing
+tests, while also prioratizing modularity and extensibility. Fortuno provides
+the essential building blocks to help developers create customized unit testing
+solutions.
+
+This repository is an automatically deployed version of the `Fortuno repository
+<https://github.com/fortuno-repos/fortuno>`_ for projects built using the
+`Fortran package manager (fpm) <https://fpm.fortran-lang.org/>`_. For projects
+built with other systems like `CMake <https://cmake.org/>`_ or `Meson
+<https://mesonbuild.com/>`_, you should refer to the `main Fortuno repository
+<https://github.com/fortuno-repos/fortuno>`_.
+
+If your project uses fpm, simply add one (and only one) of the following
+repositories as a development dependency in your ``fpm.toml`` file to integrate
+Fortuno into your unit testing process:
+
+* **Serial interface**: If your project only requires the serial interface from
+  the ``fortuno_serial`` module, add this to your ``fpm.toml``::
 
     [dev-dependencies]
     fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-serial.git" }
 
 
-* `<https://github.com/fortuno-repos/fortuno-fpm-mpi.git>`_: if you also need
-  (additional to the serial one) the **MPI interface** offered by the
-  ``fortuno_mpi`` module. Your project must declare the MPI framework as an
-  additional meta-package dependency::
+* **MPI interface**: If your project requires the MPI interface from the
+  ``fortuno_mpi`` module, add the snippet below to your ``fpm.toml``. You also
+  must declare the metapackage MPI as dependency::
 
       [dependencies]
       mpi = "*"
@@ -35,21 +38,17 @@ one) of the following repositories as development dependency to your
       fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-mpi.git" }
 
 
-* `<https://github.com/fortuno-repos/fortuno-fpm-coarray.git>`_: if you also
-  need (additional to the serial one) the **coarray interface** offered by the
-  ``fortuno_coarray`` module. Your project must be compiled with the right
-  compiler and linker flags enabling coarray features::
+* **Coarray interface**: If your project needs the coarray interface offered by
+  the ``fortuno_coarray`` module, use the following dependency. Ensure your
+  project is compiled with the appropriate compiler and linker flags to enable
+  coarray support::
 
       [dev-dependencies]
       fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-coarray.git" }
 
 
-If your projects uses the `CMake <https://cmake.org/>`_ or the `Meson
-<https://mesonbuild.com/>`_ build systems, you must use the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_ directly.
-
-For documentation, pull requests, issues, etc. refer to the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_.
+For more information, including documentation, issues and pull requests, please
+visit the `Fortuno repository <https://github.com/fortuno-repos/fortuno>`_.
 
 
 License

diff --git a/devel/fpm-repo/serial/addons/README.rst b/devel/fpm-repo/serial/addons/README.rst
@@ -2,31 +2,34 @@
 Fortuno – flextensible unit testing framework for Fortran
 *********************************************************
 
-The **Fortuno** (Fortran Unit Testing Objects) project offers a flexible &
-extensible, object oriented unit testing framework for the Fortran language. It
-puts strong emphasis on the simplicity of the user interface by minimizing the
-amount of boiler plate code when writing unit tests, as well as to modularity
-and extensibility by offering building blocks for customized unit testing
-systems.
-
-This is an automatically deployed version of the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_ for projects building with the
-`Fortran package manager (fpm) <https://fpm.fortran-lang.org/>`_. If you are
-using `fpm <https://fpm.fortran-lang.org/>`_ in your project, add one (and only
-one) of the following repositories as development dependency to your
-``fpm.toml`` manifest file in order to use the Fortuno unit testing framework:
-
-* `<https://github.com/fortuno-repos/fortuno-fpm-serial.git>`_: if you only need
-  the **serial interface** offered by the ``fortuno_serial`` module::
+**Fortuno** (Fortran Unit Testing Objects) is a flexible & extensible,
+object-oriented unit testing framework designed for the Fortran programming
+language. It emphasizes ease of use by minimizing boiler plate code when writing
+tests, while also prioratizing modularity and extensibility. Fortuno provides
+the essential building blocks to help developers create customized unit testing
+solutions.
+
+This repository is an automatically deployed version of the `Fortuno repository
+<https://github.com/fortuno-repos/fortuno>`_ for projects built using the
+`Fortran package manager (fpm) <https://fpm.fortran-lang.org/>`_. For projects
+built with other systems like `CMake <https://cmake.org/>`_ or `Meson
+<https://mesonbuild.com/>`_, you should refer to the `main Fortuno repository
+<https://github.com/fortuno-repos/fortuno>`_.
+
+If your project uses fpm, simply add one (and only one) of the following
+repositories as a development dependency in your ``fpm.toml`` file to integrate
+Fortuno into your unit testing process:
+
+* **Serial interface**: If your project only requires the serial interface from
+  the ``fortuno_serial`` module, add this to your ``fpm.toml``::
 
     [dev-dependencies]
     fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-serial.git" }
 
 
-* `<https://github.com/fortuno-repos/fortuno-fpm-mpi.git>`_: if you also need
-  (additional to the serial one) the **MPI interface** offered by the
-  ``fortuno_mpi`` module. Your project must declare the MPI framework as an
-  additional meta-package dependency::
+* **MPI interface**: If your project requires the MPI interface from the
+  ``fortuno_mpi`` module, add the snippet below to your ``fpm.toml``. You also
+  must declare the metapackage MPI as dependency::
 
       [dependencies]
       mpi = "*"
@@ -35,21 +38,17 @@ one) of the following repositories as development dependency to your
       fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-mpi.git" }
 
 
-* `<https://github.com/fortuno-repos/fortuno-fpm-coarray.git>`_: if you also
-  need (additional to the serial one) the **coarray interface** offered by the
-  ``fortuno_coarray`` module. Your project must be compiled with the right
-  compiler and linker flags enabling coarray features::
+* **Coarray interface**: If your project needs the coarray interface offered by
+  the ``fortuno_coarray`` module, use the following dependency. Ensure your
+  project is compiled with the appropriate compiler and linker flags to enable
+  coarray support::
 
       [dev-dependencies]
       fortuno = { git = "https://github.com/fortuno-repos/fortuno-fpm-coarray.git" }
 
 
-If your projects uses the `CMake <https://cmake.org/>`_ or the `Meson
-<https://mesonbuild.com/>`_ build systems, you must use the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_ directly.
-
-For documentation, pull requests, issues, etc. refer to the `Fortuno repository
-<https://github.com/fortuno-repos/fortuno>`_.
+For more information, including documentation, issues and pull requests, please
+visit the `Fortuno repository <https://github.com/fortuno-repos/fortuno>`_.
 
 
 License