You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -45,16 +45,16 @@ cd stdlib
45
45
46
46
To build the Fortran standard library you need
47
47
48
-
- a Fortran 2008 compliant compiler, better a Fortran 2018 compliant compiler
49
-
(GCC Fortran or Intel Fortran compilers are known to work for stdlib)
50
-
- CMake version 3.14 or newer (alternatively make can be used)
51
-
- a build backend for CMake, like make or ninja (the latter is recommended on Windows)
52
-
- the [``fypp``](https://github.com/aradi/fypp) preprocessor (used as meta-programming tool)
48
+
- a Fortran 2008 compliant compiler, or better, a Fortran 2018 compliant compiler
49
+
(GCC Fortran and Intel Fortran compilers are known to work for stdlib)
50
+
- CMake version 3.14 or newer (alternatively Make can be used)
51
+
- a build backend for CMake, like Make or Ninja (the latter is recommended on Windows)
52
+
- the [fypp](https://github.com/aradi/fypp) preprocessor (used as meta-programming tool)
53
53
54
54
If your system package manager does not provide the required build tools, all build dependencies can be installed with the Python command line installer ``pip``:
55
55
56
56
```sh
57
-
pip install fypp cmake ninja
57
+
pip install --user fypp cmake ninja
58
58
```
59
59
60
60
Alternatively, you can install the build tools from the conda-forge channel with the conda package manager:
You can install conda from using the [miniforge installer](https://github.com/conda-forge/miniforge/releases).
69
-
Also, you can install a Fortran compiler from conda-forge by installing the ``fortran-compiler`` package, which installs ``gfortran``.
68
+
You can install conda using the [miniforge installer](https://github.com/conda-forge/miniforge/releases).
69
+
Also, you can install a Fortran compiler from conda-forge by installing the ``fortran-compiler`` package, which installs GFortran.
70
70
71
71
72
72
### Build with CMake
@@ -77,18 +77,18 @@ Configure the build with
77
77
cmake -B build
78
78
```
79
79
80
-
you can pass additional options to CMake to customize the build.
80
+
You can pass additional options to CMake to customize the build.
81
81
Important options are
82
82
83
-
-`-G Ninja` to use the ninja backend instead of the default make backend, other build backends are available with a similar syntax
83
+
-`-G Ninja` to use the Ninja backend instead of the default Make backend. Other build backends are available with a similar syntax.
84
84
-`-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library.
85
85
-`-DCMAKE_MAXIMUM_RANK` the maximum array rank procedures should be generated for.
86
86
The default is 15 for Fortran 2003 compliant compilers, otherwise 7 for compilers not supporting Fortran 2003 completely yet.
87
87
The minimum required rank to compile this project is 4.
88
88
Compiling with maximum rank 15 can be resource intensive and requires at least 16 GB of memory to allow parallel compilation or 4 GB memory for sequential compilation.
89
89
-`-DBUILD_SHARED_LIBS` set to `on` in case you want link your application dynamically against the standard library (default: `off`).
90
90
91
-
For example, to configure a build using the ninja backend and generating procedures up to rank 7, which is installed to your home directory use
91
+
For example, to configure a build using the Ninja backend and generating procedures up to rank 7, which is installed to your home directory use
@@ -100,7 +100,7 @@ To build the standard library run
100
100
cmake --build build
101
101
```
102
102
103
-
To test your build setup run the projects testsuite after the build has finished with
103
+
To test your build, run the test suite after the build has finished with
104
104
105
105
```sh
106
106
cmake --build build --target test
@@ -134,7 +134,7 @@ make -f Makefile.manual FYPPFLAGS=-DMAXRANK=4
134
134
135
135
## Documentation
136
136
137
-
Documentation is a work in progress (see issue [#4](https://github.com/fortran-lang/stdlib/issues/4)) but alrealy available at https://stdlib.fortran-lang.org.
137
+
Documentation is a work in progress (see issue [#4](https://github.com/fortran-lang/stdlib/issues/4)) but already available at [stdlib.fortran-lang.org](https://stdlib.fortran-lang.org).
138
138
This includes API documentation automatically generated from static analysis and markup comments in the source files
139
139
using the [FORD](https://github.com/Fortran-FOSS-programmers/ford/wiki) tool,
140
140
as well as a specification document or ["spec"](https://stdlib.fortran-lang.org/page/specs/index.html) for each proposed feature.
0 commit comments