aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 28f5ace3ef2b6dd89a184adb40b1c60bb22c32f0 (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
60
# Fortran Package Manager

This is the repository of the Fortran Package Manager (fpm).
If you are looking for the Effing Package Management instead, see
[jordansissel/fpm](https://github.com/jordansissel/fpm).

Fortran Package Manager is an early prototype.
You can use it to build and package your Fortran projects, as
well as to include supported Fortran dependency projects.
As a prototype, changes to fpm's behavior and inputs may occur as development continues.
Please follow the [issues](https://github.com/fortran-lang/fpm/issues)
to contribute and/or stay up to date with the development.
As the prototype matures and we enter production, we will do our best to stay backwards compatible.

## Getting started

### Install Haskell

To install **Haskell Stack**, follow these [instructions](https://docs.haskellstack.org/en/stable/README/)

### Download this repository

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

### Build and Test fpm

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

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

On Linux, the above command installs `fpm` 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).