From 1a240de24759dc98b9999641b92c2b933c73f3b6 Mon Sep 17 00:00:00 2001 From: w-bonelli Date: Thu, 8 Sep 2022 10:47:04 -0400 Subject: [PATCH] refactor: rename verify -> test, update README --- .github/workflows/commit.yml | 4 +-- README.md | 28 +++++++++++++++---- .../test_install.ps1} | 0 .../test_install.sh} | 0 4 files changed, 24 insertions(+), 8 deletions(-) rename scripts/{verify/verify_install.ps1 => test/test_install.ps1} (100%) rename scripts/{verify/verify_install.sh => test/test_install.sh} (100%) diff --git a/.github/workflows/commit.yml b/.github/workflows/commit.yml index 46febee..0abd163 100644 --- a/.github/workflows/commit.yml +++ b/.github/workflows/commit.yml @@ -23,7 +23,7 @@ jobs: uses: ./ - name: Check installation run: | - ./scripts/verify/verify_install.sh /usr/local/bin/gfortran + ./scripts/test/test_install.sh /usr/local/bin/gfortran test_windows: name: Test (Windows) runs-on: windows-latest @@ -35,4 +35,4 @@ jobs: - name: Check installation shell: pwsh run: | - ./scripts/verify/verify_install.ps1 \ No newline at end of file + ./scripts/test/test_install.ps1 \ No newline at end of file diff --git a/README.md b/README.md index 4edf630..498c486 100644 --- a/README.md +++ b/README.md @@ -5,25 +5,41 @@ An action to install the [GNU Fortran](https://gcc.gnu.org/fortran/) compiler. + + + +- [Usage](#usage) +- [Install location](#install-location) + - [Linux](#linux) + - [MacOS](#macos) + - [Windows](#windows) +- [Disclaimer](#disclaimer) + + + ## Usage To use this action, add a step like the following to your workflow: ```yaml - name: Install GNU Fortran - uses: modflowpy/install-gfortran-action@v1 + uses: modflowpy/install-gfortran-action@v0.0.1 ``` -### Install location +## Install location -#### Linux +### Linux On Linux `gfortran` version 10 is installed to `/usr/bin/gfortran-10` and symlinked to `/usr/local/bin/gfortran`. -#### MacOS +### MacOS On MacOS `gfortran` version 11 is installed to `/usr/local/bin/gfortran-11` and symlinked to `/usr/local/bin/gfortran`. -#### Windows +### Windows + +On Windows `gfortran` is installed via Chocolatey. + +## Disclaimer -On Windows `gfortran` is installed via Chocolatey. \ No newline at end of file +This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software. diff --git a/scripts/verify/verify_install.ps1 b/scripts/test/test_install.ps1 similarity index 100% rename from scripts/verify/verify_install.ps1 rename to scripts/test/test_install.ps1 diff --git a/scripts/verify/verify_install.sh b/scripts/test/test_install.sh similarity index 100% rename from scripts/verify/verify_install.sh rename to scripts/test/test_install.sh