Skip to content

Commit

Permalink
Add link to cookiecutter template generator
Browse files Browse the repository at this point in the history
  • Loading branch information
aradi committed May 20, 2024
1 parent 9a4bc48 commit 086bb11
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,17 @@ The development can be followed and joined at the `Fortuno project
Quickstart
==========

The following instructions demonstrate how to add unit tests testing serial code
via Fortuno to an existing project, which uses fpm, CMake or Meson as build
system. If you are not familiar with any of these build systems, visit the
`Fortuno documentation <https://fortuno.readthedocs.io>`_ for a step-by-step
guide starting from scratch.

In the examples below, we will assume that your library has a module ``mylib``,
which provides a function ``factorial()`` for calculating the factorial of
integers. Adapt those names to your actual library and routine names.
If you want to start a new project utilizing the Fortuno unit testing framework,
use the `Cookiecutter-Fortran-project
<https://github.com/fortuno-repos/cookiecutter-fortran-project>`_ template
generator to obtain a minimal, ready to build, run and install project with
selectable build system (CMake, Fpm or Meson) and Fortuno integration.

If you wish to add Fortuno unit tests to an already existing project, follow the
instructions below. In the examples it will be assumed that your library has a
module ``mylib``, which provides a function ``factorial()`` for calculating the
factorial of integers. Adapt those names to your actual library and routine
names.


Obtaining Fortuno
Expand Down

0 comments on commit 086bb11

Please sign in to comment.