Skip to content

Commit d0703c3

Browse files
committed
readme update
1 parent 1fa3c93 commit d0703c3

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,20 @@ To generate the documentation using [FORD](https://github.com/Fortran-FOSS-Progr
6767
ford numdiff.md
6868
```
6969

70+
By default, the library is built with double precision (`real64`) real values. Explicitly specifying the real kind can be done using the following processor flags:
71+
72+
Preprocessor flag | Kind | Number of bytes
73+
----------------- | ----- | ---------------
74+
`REAL32` | `real(kind=real32)` | 4
75+
`REAL64` | `real(kind=real64)` | 8
76+
`REAL128` | `real(kind=real128)` | 16
77+
78+
For example, to build a single precision version of the library, use:
79+
80+
```
81+
fpm build --profile release --flag "-DREAL32"
82+
```
83+
7084
## Documentation
7185

7286
The latest API documentation can be found [here](https://jacobwilliams.github.io/NumDiff/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford) (note that the included `build.sh` script will also generate these files).

0 commit comments

Comments
 (0)