-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
67 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
[](https://github.com/gha3mi/forunittest) | ||
[](https://github.com/gha3mi/forunittest/releases/latest) | ||
[](https://gha3mi.github.io/forunittest/) | ||
[](https://github.com/gha3mi/forunittest/blob/main/LICENSE) | ||
[](https://github.com/gha3mi/forunittest/actions/workflows/CI_test.yml) | ||
|
||
<!-- <img alt="ForUnitTest" src="https://github.com/gha3mi/forunittest/raw/main/media/logo.png" width="750"> --> | ||
|
||
**ForUnitTest**: A Fortran library for unit testing. | ||
|
||
## Usage | ||
|
||
```fortran | ||
use forunittest | ||
type(unit_test) :: ut | ||
call ut%check(res, expected, tol, msg) | ||
``` | ||
|
||
See `example/demo.f90` for a complete example. | ||
|
||
## fpm dependency | ||
|
||
To use `ForUnitTest` as a dependency in your fpm project, include the following line in your `fpm.toml` file: | ||
|
||
```toml | ||
[dependencies] | ||
forunittest = {git="https://github.com/gha3mi/forunittest.git"} | ||
``` | ||
|
||
## How to Run the Demo | ||
|
||
**Clone the repository:** | ||
|
||
Clone the `ForUnitTest` repository from GitHub using: | ||
|
||
```shell | ||
git clone https://github.com/gha3mi/forunittest.git | ||
cd forunittest | ||
``` | ||
|
||
**Run the demo:** | ||
|
||
```shell | ||
fpm run --example demo | ||
``` | ||
|
||
## API documentation | ||
|
||
The most up-to-date API documentation for the main branch is available | ||
[here](https://gha3mi.github.io/forunittest/). | ||
To generate the API documentation for `ForUnitTest` using | ||
[ford](https://github.com/Fortran-FOSS-Programmers/ford) run the following | ||
command: | ||
|
||
```shell | ||
ford ford.yml | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions to `ForUnitTest` are welcome! | ||
If you find any issues or would like to suggest improvements, please open an issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters