diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 0e3517b..ad13ab2 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -39,7 +39,7 @@ jobs: if: contains( matrix.os, 'ubuntu') run: | python -m pip install --upgrade pip - pip install ford numpy matplotlib + pip install numpy matplotlib ford if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - name: Install GFortran Linux @@ -76,7 +76,7 @@ jobs: files: build/coverage/coverage.info - name: Build documentation - run: ford ./pyplot-fortran.md + run: ford ./ford.md - name: Deploy Documentation if: github.ref == 'refs/heads/master' diff --git a/README.md b/README.md index fbba96b..a6bda84 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A simple module for generating plots from Fortran using Python's matplotlib.pyplot. -### Status +### Status [![GitHub release](https://img.shields.io/github/release/jacobwilliams/pyplot-fortran.svg?style=plastic)](https://github.com/jacobwilliams/pyplot-fortran/releases/latest) ![Build Status](https://github.com/jacobwilliams/pyplot-fortran/actions/workflows/CI.yml/badge.svg) @@ -18,9 +18,9 @@ is then executed from the command line using the Fortran ```execute_command_line ### Compiling -The module requires a modern Fortran compiler (it uses various Fortran 2003/2008 features such as deferred-length strings). It should work fine with the latest gfortran or ifort compilers. +The module requires a modern Fortran compiler (it uses various Fortran 2003/2008 features such as deferred-length strings). It should work fine with the latest gfortran or ifort compilers. -A `fmp.toml` file is provided for compiling pyplot-fortran with the [Fortran Package Manager](https://github.com/fortran-lang/fpm). For example, to build: +A `fpm.toml` file is provided for compiling pyplot-fortran with the [Fortran Package Manager](https://github.com/fortran-lang/fpm). For example, to build: ``` fpm build --profile release @@ -58,7 +58,7 @@ or, to use a specific version: pyplot-fortran = { git="https://github.com/jacobwilliams/pyplot-fortran.git", tag = "3.3.0" } ``` -To generate the documentation using [ford](https://github.com/Fortran-FOSS-Programmers/ford), run: ```ford pyplot-fortran.md``` +To generate the documentation using [ford](https://github.com/Fortran-FOSS-Programmers/ford), run: ```ford ford.md``` ### Supported plot types @@ -103,7 +103,7 @@ The following example generates a plot of the sine function: ### Documentation - * The API documentation for the current ```master``` branch can be found [here](https://jacobwilliams.github.io/pyplot-fortran/). This is generated by processing the source files with [FORD](https://github.com/Fortran-FOSS-Programmers/ford). + * The API documentation for the current ```master``` branch can be found [here](https://jacobwilliams.github.io/pyplot-fortran/). This is generated by processing the source files with [FORD](https://github.com/Fortran-FOSS-Programmers/ford). ### See also diff --git a/pyplot-fortran.md b/ford.md similarity index 100% rename from pyplot-fortran.md rename to ford.md