Skip to content

Commit 77cc356

Browse files
authored
Merge pull request #778 from fortran-lang/gnikit/issue776
docs: simplify & update README
2 parents e3487c5 + a3975a0 commit 77cc356

File tree

1 file changed

+30
-63
lines changed

1 file changed

+30
-63
lines changed

README.md

Lines changed: 30 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Fortran Package Manager
1+
<p align="center">
2+
<a href="https://fpm.fortran-lang.org/"><img src="https://raw.githubusercontent.com/fortran-lang/assets/main/fpm/logo/2-color-alt/png/full-color-alt.png" width="800"/></a>
3+
</p>
4+
5+
# [Fortran Package Manager](https://fpm.fortran-lang.org/)
26

37
Fortran Package Manager (fpm) is a package manager and build system for Fortran.
48
Its key goal is to improve the user experience of Fortran programmers.
@@ -27,32 +31,36 @@ Fortran Package Manager is not to be confused with
2731
[Jordan Sissel's fpm](https://github.com/jordansissel/fpm), a more general,
2832
non-Fortran related package manager.
2933

30-
## Getting started
34+
**Website: <https://fpm.fortran-lang.org/>**
35+
36+
## [Download](https://fpm.fortran-lang.org/en/how-to/installation.html)
37+
38+
Fpm is available on many platforms and through multiple package managers, see our Documentation
39+
webpage for a list of **[All Supported Installations](https://fpm.fortran-lang.org/en/how-to/installation.html)**.
3140

32-
### Setting up fpm
41+
The easiest installation routes are shown below.
3342

34-
#### Binary download
43+
### [Binary](https://github.com/fortran-lang/fpm/releases)
3544

3645
Binaries for the latest stable release are available [to download](https://github.com/fortran-lang/fpm/releases/latest) for Windows, MacOS, and Linux.
3746

38-
__Note:__ On Linux and MacOS, you will need to enable executable permission before you can use the binary.
47+
**Note:** On Linux and MacOS, you will need to enable executable permission before you can use the binary.
3948

4049
_e.g._ `$ chmod u+x fpm-0.6.0-linux-x86_64`
4150

4251
The binaries at the [current tag](https://github.com/fortran-lang/fpm/releases/tag/current) are updated automatically to always provide the current git version from the default branch.
4352

53+
### [Conda]
4454

45-
#### [Conda]
55+
Fpm is available on [conda-forge], to add `conda-forge` to your channels use:
4656

47-
Fpm is available on [conda-forge], to add conda-forge to your channels use:
48-
49-
```
57+
```sh
5058
conda config --add channels conda-forge
5159
```
5260

5361
Fpm can be installed with:
5462

55-
```
63+
```sh
5664
conda create -n fpm fpm
5765
conda activate fpm
5866
```
@@ -63,51 +71,12 @@ or from [miniconda](https://docs.conda.io/en/latest/miniconda.html).
6371
[Conda]: https://conda.io
6472
[conda-forge]: https://conda-forge.org/
6573

66-
67-
#### [MSYS2]
68-
69-
Fpm is available as MinGW package in the MSYS2 package manager,
70-
which supports parallelization of the target compilation.
71-
To install fpm with pacman use
72-
73-
```
74-
pacman -S mingw-w64-x86_64-fpm
75-
```
76-
77-
Afterwards fpm will be available for usage.
78-
Currently `i686`, `x86_64` and `ucrt-x86_64` are supported MinGW architectures for fpm.
79-
For more details check the package information [here](https://packages.msys2.org/base/mingw-w64-fpm).
80-
81-
[MSYS2]: https://www.msys2.org/
82-
83-
84-
#### [Spack]
85-
86-
Fpm is available with spack in its develop version.
87-
To install fpm from spack use
88-
89-
```
90-
spack install fpm
91-
```
92-
93-
You can add `+openmp` to enable parallelization of the target compilation in fpm.
94-
To use fpm in your environment load it with
95-
96-
```
97-
spack load fpm
98-
```
99-
100-
For more details check the package information [here](https://spack.readthedocs.io/en/latest/package_list.html#fpm).
101-
102-
[Spack]: https://spack.io
103-
104-
105-
#### Homebrew
74+
### [Homebrew](https://brew.sh/)
10675

10776
The Fortran Package Manager (fpm) is available for the [Homebrew](https://brew.sh/) package manager via an additional tap.
10877
To install fpm via brew, include the new tap and install using
10978

110-
```
79+
```sh
11180
brew tap fortran-lang/fortran
11281
brew install fpm
11382
```
@@ -117,15 +86,11 @@ Binary distributions are available for MacOS 11 (Catalina) and 12 (Big Sur) for
11786
Fpm should be available and functional after those steps.
11887
For more details checkout the tap [here](https://github.com/fortran-lang/homebrew-fortran).
11988

120-
#### Github Actions
121-
122-
To setup *fpm* within Github actions for automated testing, you can use the [fortran-lang/setup-fpm](https://github.com/marketplace/actions/setup-fpm) action.
89+
## [Get started](https://fpm.fortran-lang.org/en/tutorial/index.html)
12390

124-
#### Bootstrapping on other platforms
91+
**Follow our [Quickstart Tutorial](https://fpm.fortran-lang.org/en/tutorial/hello-fpm.html) to get familiar with fpm**.
12592

126-
For other platforms and architectures have a look at the [bootstrapping instructions](#bootstrapping-instructions).
127-
128-
### Creating a new project
93+
### Start a new project
12994

13095
Creating a new *fpm* project is as simple as running the command
13196
`fpm new project_name`. This will create a new folder in your current directory
@@ -153,9 +118,9 @@ arguments can also be passed to the executable(s) or test(s) with the option
153118
`-- some arguments`.
154119

155120
See additional instructions in the [Packaging guide](PACKAGING.md) or
156-
the [manifest reference](manifest-reference.md).
157-
121+
the [manifest reference](https://fpm.fortran-lang.org/en/spec/manifest.html).
158122

123+
<!--
159124
### Bootstrapping instructions
160125
161126
This guide explains the process of building *fpm* on a platform for the first time.
@@ -164,7 +129,7 @@ at each release.
164129
165130
To build manually using the single source distribution, run the following code (from within the current directory)
166131
167-
```
132+
```sh
168133
mkdir _tmp
169134
curl -LJ https://github.com/fortran-lang/fpm/releases/download/current/fpm.F90 > _tmp/fpm.F90
170135
gfortran -J _tmp _tmp/fpm.F90 -o _tmp/fpm
@@ -174,9 +139,11 @@ rm -r _tmp
174139
175140
To automatically bootstrap using this appoach run the install script
176141
177-
```
142+
```sh
178143
./install.sh
179-
```
144+
``` -->
145+
146+
## Environmental variables
180147

181148
The table below lists the environment variables that control `fpm`'s choice of compilers,
182149
compiler flags, archiver locations, and link flags, each of which can be overridden by

0 commit comments

Comments
 (0)