aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b6ff2658e77469bb1e9eb54fca583bb4cd31f586 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Fortran Package Manager

A prototype version.

## Getting started

### Install Haskell

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:
```
export PATH="$PATH:`pwd`/stack-2.1.3-linux-x86_64-static/"
```

### Download this repository

```
git clone https://github.com/fortran-lang/fpm
cd fpm
```

### Build and Test fpm

Make sure that the developers library of `gmp` is installed (e.g. `sudo apt install libgmp-dev` on Debian-derived Linux distributions)

Build fpm using:
```
stack build
```
To test:
```
stack test
```
To install:
```
stack install
```

On Linux, the above command installs `stack` to `${HOME}/.local/bin`.

### Building your Fortran project with fpm

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).