aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad Richardson <brichardson@structint.com>2020-06-06 20:53:53 -0700
committerBrad Richardson <brichardson@structint.com>2020-06-06 20:53:53 -0700
commitb1ea7e44f6d421ad8ec8f711f99aa89d171e4e0f (patch)
tree7b62f7015003d2d976dfc39a845ff4fdc0754280
parent76439d06aee45e45c1a990e3d47634753dec59ef (diff)
downloadfpm-b1ea7e44f6d421ad8ec8f711f99aa89d171e4e0f.tar.gz
fpm-b1ea7e44f6d421ad8ec8f711f99aa89d171e4e0f.zip
Add some info about fpm commands to the README
-rw-r--r--README.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/README.md b/README.md
index ab92fcb..e3e1e1c 100644
--- a/README.md
+++ b/README.md
@@ -24,9 +24,9 @@ git clone https://github.com/fortran-lang/fpm
cd fpm
```
-### Build and Test FPM
+### Build and Test fpm
-Build FPM using:
+Build fpm using:
```
stack build
```
@@ -41,6 +41,17 @@ stack install
On Linux, the above command installs `stack` to `${HOME}/.local/bin`.
-### Building your Fortran project with FPM
+### Building your Fortran project with fpm
-Please follow the instructions in the [Packaging guide](PACKAGING.md).
+fpm understands the basic commands:
+
+* `fpm build` - build your library, executables and tests
+* `fpm run` - run executables
+* `fpm test`- run tests
+
+The command `fpm run` can optionally accept the name of the specific executable
+to run, as can `fpm test`; like `fpm run specifc_executable`. Command line
+arguments can also be passed to the executable(s) or test(s) with the option
+`--args "some arguments"`.
+
+See additional instructions in the [Packaging guide](PACKAGING.md).