Skip to content

Commit 43a3da1

Browse files
garethgareth
gareth
authored and
gareth
committed
make the default INSTALL_PREFIX clearer in the documentation
1 parent cfb472f commit 43a3da1

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ You can pass additional options to CMake to customize the build.
125125
Important options are
126126

127127
- `-G Ninja` to use the Ninja backend instead of the default Make backend. Other build backends are available with a similar syntax.
128-
- `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library.
128+
- `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library. If not provided, this defaults to `stdlib_install` in the `stdlib` directory.
129129
- `-DCMAKE_MAXIMUM_RANK` the maximum array rank procedures should be generated for.
130130
The default value is chosen as 4.
131131
The maximum is 15 for Fortran 2003 compliant compilers, otherwise 7 for compilers not supporting Fortran 2003 completely yet.
@@ -153,7 +153,7 @@ cmake --build build --target test
153153

154154
Please report failing tests on our [issue tracker](https://github.com/fortran-lang/stdlib/issues/new/choose) including details of the compiler used, the operating system and platform architecture.
155155

156-
To install the project to the declared prefix run
156+
To install the project to the declared prefix (by default `stdlib_install` in the `stdlib` directory), run
157157

158158
```sh
159159
cmake --install build
@@ -199,7 +199,7 @@ To make the installed stdlib project discoverable add the stdlib directory to th
199199
The usual install localtion of the package files is ``$PREFIX/lib/cmake/fortran_stdlib``.
200200

201201
For non-CMake build systems (like make) you can use the exported pkg-config file by setting ``PKG_CONFIG_PATH`` to include the directory containing the exported pc-file.
202-
The usual install location of the pc-file is ``$PREFIX/lib/pkgconfig``.
202+
The usual install location of the pc-file is ``$PREFIX/lib/pkgconfig`` (by default, `stdlib_install/lib/pkgconfig` in the `stdlib` directory).
203203
In make you can obtain the required compile and link arguments with
204204

205205
```make

0 commit comments

Comments
 (0)