# Fortran Package Manager

This is the repository of the Fortran Package Manager (*fpm*). If you are
looking for *fpm – packaging made simple* 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.

To report a bug report or suggest a feature, please read our
[contributor guidelines](CONTRIBUTING.md).

## Getting started

### Binary download
`x86-64` binaries are available [to download](https://github.com/fortran-lang/fpm/releases) for Windows, MacOS and Linux.

__Note:__ On Linux and MacOS, you will need to enable executable permission before you can use the binary.

_e.g._ `$ chmod u+x fpm-v0.1.0-linux-x86_64`

For other platforms and architectures have a look at the [bootstrapping instructions](#bootstrapping-fpm).

### Creating a new project

Creating a new *fpm* project is as simple as running the command
`fpm new project_name`. This will create a new folder in your current directory
with the following contents and initialized as a git repository.

* `fpm.toml` – with your project’s name and some default standard meta-data
* `README.md` – with your project’s name
* `.gitignore`
* `src/project_name.f90` – with a simple hello world subroutine
* `app/main.f90` (if `--with-executable` flag used) – a program that calls the subroutine
* `test/main.f90` (if `--with-test` flag used) – an empty test program

### 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 specific_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) or
the [manifest reference](manifest-reference.md).

<details>
<summary><b>Bootstrapping instructions</b></summary>

### Bootstrapping instructions

This guide explains the process of building *fpm* on a platform for the first time.
If your platform and architecture are already supported, download the binary from the [release page](https://github.com/fortran-lang/fpm/releases) instead.

#### Install Haskell

To install **Haskell Stack**, follow these
[instructions](https://docs.haskellstack.org/en/stable/install_and_upgrade/),
users without superuser (admin) permissions should follow the
[manual installation](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2)
procedure.

#### Download this repository

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

#### Build and test fpm

Bootstrap *fpm* using:

```bash
$ cd bootstrap/
$ stack build
```

To test:

```bash
$ stack test
```

To install:

```bash
$ stack install
```

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

Now you can build the Fortran *fpm* version with

```bash
$ cd fpm/
$ fpm build
```

Test that everything is working as expected

```bash
$ fpm test
```

Finally, install the Fortran *fpm* version with

```bash
$ fpm run --runner cp -- ~/.local/bin
```

Or choose another location if you do not want to overwrite the bootstrapping version.
From now on you can rebuild *fpm* with your Fortran *fpm* version.

</details>