Skip to content

Commit c9f3195

Browse files
awvwgkmilancurcic
andauthored
Apply suggested wording and spelling changes
Co-authored-by: Milan Curcic <caomaco@gmail.com>
1 parent ece1971 commit c9f3195

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ cd stdlib
4545

4646
To build the Fortran standard library you need
4747

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)
5353

5454
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``:
5555

5656
```sh
57-
pip install fypp cmake ninja
57+
pip install --user fypp cmake ninja
5858
```
5959

6060
Alternatively, you can install the build tools from the conda-forge channel with the conda package manager:
@@ -65,8 +65,8 @@ conda create -n stdlib-tools fypp cmake ninja
6565
conda activate stdlib-tools
6666
```
6767

68-
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.
7070

7171

7272
### Build with CMake
@@ -77,18 +77,18 @@ Configure the build with
7777
cmake -B build
7878
```
7979

80-
you can pass additional options to CMake to customize the build.
80+
You can pass additional options to CMake to customize the build.
8181
Important options are
8282

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.
8484
- `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library.
8585
- `-DCMAKE_MAXIMUM_RANK` the maximum array rank procedures should be generated for.
8686
The default is 15 for Fortran 2003 compliant compilers, otherwise 7 for compilers not supporting Fortran 2003 completely yet.
8787
The minimum required rank to compile this project is 4.
8888
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.
8989
- `-DBUILD_SHARED_LIBS` set to `on` in case you want link your application dynamically against the standard library (default: `off`).
9090

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
9292

9393
```sh
9494
cmake -B build -G Ninja -DCMAKE_MAXIMUM_RANK=7 -DCMAKE_INSTALL_PREFIX=$HOME/.local
@@ -100,7 +100,7 @@ To build the standard library run
100100
cmake --build build
101101
```
102102

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
104104

105105
```sh
106106
cmake --build build --target test
@@ -134,7 +134,7 @@ make -f Makefile.manual FYPPFLAGS=-DMAXRANK=4
134134

135135
## Documentation
136136

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).
138138
This includes API documentation automatically generated from static analysis and markup comments in the source files
139139
using the [FORD](https://github.com/Fortran-FOSS-programmers/ford/wiki) tool,
140140
as well as a specification document or ["spec"](https://stdlib.fortran-lang.org/page/specs/index.html) for each proposed feature.

0 commit comments

Comments
 (0)