aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamian Rouson <rouson@lbl.gov>2021-10-29 16:13:18 -0700
committerGitHub <noreply@github.com>2021-10-29 16:13:18 -0700
commit9622e5988ac879de5de35af69a188084ca01da8a (patch)
treeae191f46244238ef584742bfb22dd674d10abd3e
parent7247d5a2d07ff40b9e5e6ac51d8a6be91b23bfd8 (diff)
downloadfpm-9622e5988ac879de5de35af69a188084ca01da8a.tar.gz
fpm-9622e5988ac879de5de35af69a188084ca01da8a.zip
Update README.md compiler, archiver, & link flags
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 70d1d89..0613b3d 100644
--- a/README.md
+++ b/README.md
@@ -159,5 +159,15 @@ To automatically bootstrap using this appoach run the install script
./install.sh
```
-You can set your Fortran compiler and the compiler flags with the ``FC`` and ``FFLAGS``
-environment variables.
+The table below lists the environment variables that control `fpm`'s choice of compilers,
+compiler flags, archiver locations, and link flags, each of which can be overridden by
+passing `fpm` flags also shown in the table.
+
+| Environment Variable | Defines | Overridden by |
+| :------------------- | :-------------------- | :------------- |
+| `FPM_FC` | Fortran compiler path | `--compiler` |
+| `FPM_CC` | C compiler path | `--c-compiler` |
+| `FPM_FFLAGS` | Fortran compiler flags| `--flag` |
+| `FPM_CFLAGS` | C compiler flags | `--c-flag` |
+| `FPM_AR` | Archiver path | `--archiver` |
+| `FPM_LDFLAGS` | Link flags | `--link-flag` |