Skip to content

Commit 24e1b98

Browse files
committed
update instructions to install stack; add basic instructions for using fpm
1 parent e8c5eb5 commit 24e1b98

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

+27-5
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,50 @@
22

33
A prototype version.
44

5-
## How to try it out
5+
## Getting started
66

77
### Install Haskell
88

9-
Install Haskell Stack from (https://haskellstack.org/). E.g., to install on
10-
Linux without root access, follow the [manual download](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2):
9+
To install [Haskell Stack](https://haskellstack.org/) on
10+
Linux without root access, follow the [manual download](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2) procedure:
1111
```
1212
wget https://get.haskellstack.org/stable/linux-x86_64-static.tar.gz
1313
tar xaf linux-x86_64-static.tar.gz
1414
```
15-
and put the `stack` binary in your path, for example by:
15+
and put the `stack` binary in your path, for example:
1616
```
1717
export PATH="$PATH:`pwd`/stack-2.1.3-linux-x86_64-static/"
1818
```
1919

20+
### Download this repo
21+
22+
```
23+
git clone https://github.com/fortran-lang/fpm
24+
cd fpm
25+
```
26+
2027
### Build and Test FPM
2128

22-
Build using:
29+
Build FPM using:
2330
```
2431
stack build
2532
```
2633
To test:
2734
```
2835
stack test
2936
```
37+
To install:
38+
```
39+
stack install
40+
```
41+
42+
### Building your Fortran project with FPM
43+
44+
1. Copy `example_fpm.toml` from this repository
45+
to the base directory of your Fortran project.
46+
2. Rename it to `fpm.toml`.
47+
3. Edit `fpm.toml` for your package.
48+
4. Type `fpm build`.
49+
5. (optional) If you have tests, type `fpm test`.
50+
6. (optional) If your package is an executable program,
51+
run it by typing `fpm run`.

0 commit comments

Comments
 (0)