From b37b5d9d874deb48f4ef3fc012d48d92ea68f1d6 Mon Sep 17 00:00:00 2001 From: Dan Bonachea Date: Fri, 4 Oct 2024 16:27:37 -0700 Subject: [PATCH] Update documentation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb0c5a8..ff6c6c4 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,8 @@ preprocessor ASSERTIONS to non-zero, eg: ``` fpm build --flag "-DASSERTIONS" ``` -The program [example/invoke-via-macro.F90] demonstrates the preferred way to invoke the `assert` subroutine via the three provided macros. -Invoking `assert` this way insures that `assert` invocations will be completely removed whenever the `ASSERTIONS` macro is undefined (or defined to zero) during compilation. +The program [example/invoke-via-macro.F90] demonstrates the preferred way to invoke assertions via the three provided macros. +Invoking assertions this way ensures such calls will be completely removed whenever the `ASSERTIONS` macro is undefined (or defined to zero) during compilation. Due to a limitation of `fpm`, this approach works best if the project using Assert is also a `fpm` project. If instead `fpm install` is used, then either the user must copy `include/assert_macros.h` to the installation directory (default: `~/.local/include`) or the user must invoke `assert` directly (via `call assert(...)`).