Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gha3mi committed Apr 20, 2024
1 parent 638f5ca commit ae21f4e
Showing 1 changed file with 21 additions and 51 deletions.
72 changes: 21 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![License](https://img.shields.io/github/license/gha3mi/fortime?color=green)](https://github.com/gha3mi/fortime/blob/main/LICENSE)
[![Build](https://github.com/gha3mi/fortime/actions/workflows/CI_test.yml/badge.svg)](https://github.com/gha3mi/fortime/actions/workflows/CI_test.yml)

<img alt="ForTime" src="https://github.com/gha3mi/fortime/raw/main/media/logo.png" width="750">
<!-- <img alt="ForTime" src="https://github.com/gha3mi/fortime/raw/main/media/logo.png" width="750"> -->

**ForTime**: A Fortran library for measuring elapsed time, DATE_AND_TIME time, CPU time, OMP time and MPI time.

Expand Down Expand Up @@ -99,69 +99,39 @@ call t%mtimer_write(file_name) ! Optionally, write the result to a file

**Note:** Don't forget to compile with the `-DUSE_MPI` option when using the MPI timer.

## How to run examples
Certainly! Here's a corrected and slightly refined version of the **Running Examples and Tests** section for your README to ensure clarity and formatting consistency:

**Clone the repository:**
---

You can clone the `ForTime` repository from GitHub using the following command:
## Running Examples and Tests

### Clone the Repository

First, clone the `ForTime` repository from GitHub and navigate to the project directory:

```shell
git clone https://github.com/gha3mi/fortime.git
cd fortime
```
### Running Examples

**For Intel Fortran Compiler (ifort):**

```shell
fpm run --example --all --compiler ifort
```

**For Intel Fortran Compiler (ifx):**

```shell
fpm run --example --all --compiler ifx
```

**For NVIDIA Compiler (nvfortran):**

```shell
fpm run --example --all --compiler nvfortran
```

**For GNU Fortran Compiler (gfortran):**

```shell
fpm run --example --all --compiler gfortran
```

## How to run tests
To run a specific example from the `example` directory using your preferred Fortran compiler, use the following command:

```shell
fpm run --example <example_name> --compiler <compiler>
```
Replace `<example_name>` with the name of the example file (excluding the `.f90` extension) and `<compiler>` with the name of your Fortran compiler (e.g., `ifx`, `ifort`, `gfortran`, `nvfortran`).

**For Intel Fortran Compiler (ifort):**

```shell
fpm test --compiler ifort
```

**For Intel Fortran Compiler (ifx):**

```shell
fpm test --compiler ifx
```

**For NVIDIA Compiler (nvfortran):**

```shell
fpm test --compiler nvfortran
```
### Running Tests

**For GNU Fortran Compiler (gfortran):**
To execute tests, use the following command with your chosen compiler:

```shell
fpm test --compiler gfortran
```
```shell
fpm test --compiler <compiler>
```
Replace `<compiler>` with the name of your Fortran compiler.

## API documentation
## Documentation

The most up-to-date API documentation for the master branch is available
[here](https://gha3mi.github.io/fortime/).
Expand Down

0 comments on commit ae21f4e

Please sign in to comment.