aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMilan Curcic <caomaco@gmail.com>2020-04-26 14:40:22 -0400
committerMilan Curcic <caomaco@gmail.com>2020-04-26 14:40:22 -0400
commit24e1b98ff84d09f095f48c168e9af05aa00c95ea (patch)
tree3d4c9ffaaafcc98df7105eeade92dc5269b7060f
parente8c5eb593fafdced419ade6312c17e04ff0328f9 (diff)
downloadfpm-24e1b98ff84d09f095f48c168e9af05aa00c95ea.tar.gz
fpm-24e1b98ff84d09f095f48c168e9af05aa00c95ea.zip
update instructions to install stack; add basic instructions for using fpm
-rw-r--r--README.md32
1 files changed, 27 insertions, 5 deletions
diff --git a/README.md b/README.md
index b767268..486e861 100644
--- a/README.md
+++ b/README.md
@@ -2,24 +2,31 @@
A prototype version.
-## How to try it out
+## Getting started
### Install Haskell
-Install Haskell Stack from (https://haskellstack.org/). E.g., to install on
-Linux without root access, follow the [manual download](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2):
+To install [Haskell Stack](https://haskellstack.org/) on
+Linux without root access, follow the [manual download](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2) procedure:
```
wget https://get.haskellstack.org/stable/linux-x86_64-static.tar.gz
tar xaf linux-x86_64-static.tar.gz
```
-and put the `stack` binary in your path, for example by:
+and put the `stack` binary in your path, for example:
```
export PATH="$PATH:`pwd`/stack-2.1.3-linux-x86_64-static/"
```
+### Download this repo
+
+```
+git clone https://github.com/fortran-lang/fpm
+cd fpm
+```
+
### Build and Test FPM
-Build using:
+Build FPM using:
```
stack build
```
@@ -27,3 +34,18 @@ To test:
```
stack test
```
+To install:
+```
+stack install
+```
+
+### Building your Fortran project with FPM
+
+1. Copy `example_fpm.toml` from this repository
+to the base directory of your Fortran project.
+2. Rename it to `fpm.toml`.
+3. Edit `fpm.toml` for your package.
+4. Type `fpm build`.
+5. (optional) If you have tests, type `fpm test`.
+6. (optional) If your package is an executable program,
+run it by typing `fpm run`.