You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,22 @@
1
1
Julienne
2
2
========
3
3
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).
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.
8
16
9
17
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.
0 commit comments