Skip to content

Commit 878ddd1

Browse files
authored
doc(README): reformat and improve phrasing
1 parent dfcaa71 commit 878ddd1

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
11
Julienne
22
========
33

4-
Julienne is a modern-Fortran unit-testing framework that includes utilities for manipulating strings, including command lines and input/output format strings.
5-
Users construct tests by extending Julienne's `abstract` `test_t` derived type and constructing an array of `test_description_t` objects, each of which encapsulates a description string and the name of a function that produces one or more `test_diagnosis_t` objects, each of which in turn encapsulates a `logical` test outcome and a `diagnostics_string`.
6-
Julienne empowers users to determine the diagnostic information printed when tests fail.
7-
To support customized diagnostics output, Julienne provides a `string_t` derived type with corresponding constructor functions and useful operators.
4+
Julienne is a modern-Fortran unit-testing framework that includes utilities for manipulating strings (via Julienne's `string_t` derived type), including command line arguments (via Julienne's `command_line_t` type) and input/output format strings (via Julienne's `formats_m` module).
5+
Users construct tests by
6+
7+
1. Extending Julienne's `test_t` abstrct derived type,
8+
2. Constructing an array of `test_description_t` objects, each of which encapsulates
9+
a. A string describing what functionality is being tested and
10+
b. The reference to a function that produces one or more `test_diagnosis_t` objects, each of which encapsulates
11+
i. A `logical` indicator of the test outcome (where `.true.` denotes a pass) and
12+
ii. A `character` or `string_t` diagnostics string.
13+
14+
Julienne empowers users to customize the diagnostic information that prints when tests fail.
15+
For this purpose, Julienne's `string_t` constructors convert varios types, kinds, and ranks of data to character data and `string_t` operators support features such as concatenation and delimited lists such as comma-separated value lists.
816

917
Julienne's name derives from the term for vegetables sliced into thin strings: julienned vegetables.
10-
The structure of Julienne's tests and output was inspired by the [Veggies] unit-testing framework with the aim of being more lightweight and portable across compilers and compiler versions.
18+
The [Veggies] unit-testing framework inspired the structure of Julienne's tests and output.
19+
Julienne aims to be a more lightweight alternative that is more portable across compilers and compiler versions.
1120

1221
Getting Started
1322
---------------
@@ -18,18 +27,19 @@ Supported Compilers
1827

1928
Compiler | Version(s) Tested | Known Issues
2029
-----------------|--------------------------|-------------
30+
GCC `gfortran` | 14.1.0, 14.2.0_1, 15.0.1 | items 1-3 below
31+
Intel `ifx` | 2025.1 | item 4 below
2132
LLVM `flang-new` | 19, 20 | none
22-
Intel `ifx` | 2025.1 | none
2333
NAG `nagfor` | 7.2 Build 7227 | none
24-
GCC `gfortran` | 14.1.0, 14.2.0_1, 15.0.1 | 1-3 below
2534

2635
Compiler bugs related to the following issues have been reported to the GCC project:
2736

2837
1. The `test_description_t` constructor's `diagnosis_function` actual argument must be a procedure pointer.
2938
2. Each element of a `vector_test_description_t` array must be defined in a separate program statement.
3039
3. If executed, the `string_t` type's `bracket` procedure causes a program crash.
40+
4. Two `string_t` tests fail as described in issue [#51](https://github.com/BerkeleyLab/julienne/issues/51).
3141

32-
Some related `gfortran` fixes have already been developed and pushed to the GCC branches for release with GCC 14.3 and 15.1.0.
42+
Some `gfortran` fixes related to items 1-3 above have been pushed to the GCC repository for release with GCC 14.3 and 15.1.0.
3343

3444
Building and Testing
3545
--------------------

0 commit comments

Comments
 (0)