Skip to content

Commit 3ecac18

Browse files
author
Damian Rouson
authored
Reformat updated INSTALL.md
1 parent d97acad commit 3ecac18

File tree

1 file changed

+22
-30
lines changed

1 file changed

+22
-30
lines changed

INSTALL.md

Lines changed: 22 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ OpenCoarrays source.
4040

4141
[![homebrew](https://img.shields.io/homebrew/v/opencoarrays.svg?style=flat-square)](http://braumeister.org/formula/opencoarrays)
4242

43-
We recommend using [Homebrew] to install OpenCoarrays on macOS.
43+
* [Homebrew]: This is the recommend OpenCoarrays installation method on macOS.
4444

4545
Basic Homebrew installation steps:
4646

@@ -62,7 +62,7 @@ brew update
6262
brew bundle
6363
```
6464

65-
An unmaintained [OpenCoarrays Portfile] exists for the [MacPorts] package
65+
* [MacPorts]: An unmaintained [OpenCoarrays Portfile] exists for the [MacPorts] package
6666
manager. Although the current OpenCoarrays contributors have no plans to
6767
update the portfile, new contributors are welcome to asssume the port
6868
maintainer role and to submit a pull request to update this [INSTALL.md] file.
@@ -284,13 +284,12 @@ specified dependencies between source files.
284284

285285
### Prerequisites ###
286286

287-
The prerequisites below and their dependencies are recommended for the
288-
broadest coverage of CAF features. If a prerequisite is missing or
289-
outdated, the [install.sh] script will prompt the user for permission
290-
to download, compile, and install it. Before doing so, [install.sh]
291-
will verify whether that prerequisite's prerequisites are present and
292-
will recursively traverse the dependency tree until reaching an
293-
acceptable prerequisite or reaching the end of a branch.
287+
Package managers and the [install.sh] attempt to handle the installation
288+
of all OpenCoarrays prerequisites automatically. Installing with CMake
289+
or the provided, static Makefile burdens the person installing with the
290+
need to ensure that all prerequisites have been built and are in the
291+
expected or specified locations prior to building OpenCoarrays. The
292+
prerquisite package/version dependency tree is as follows:
294293

295294
```text
296295
opencoarrays
@@ -305,22 +304,14 @@ opencoarrays
305304
└── mpfr
306305
```
307306

308-
If using the advanced [CMake] or [Make] builds detailed below, please
309-
ensure that these dependencies are met before attempting to build and
310-
install OpenCoarrays.
311-
312307
[top]
313308

314309
### CMake scripts ###
315310

316-
As demonstrated above. the [install.sh] script offers many options for
317-
customizing the build. The script performs numerous services that make
318-
it the preferred build method if package management is unavailable.
319-
On most platforms, [install.sh] ultimately invokes [CMake] after performing
320-
numerous checks, customizations, and installations of any missing prerequisites.
321-
311+
On most platforms, the [install.sh] script ultimately invokes [CMake] after performing
312+
numerous checks, customizations, and installations of any missing prerequisites.
322313
Advanced users who prefer to invoke CMake directly may do so as described here.
323-
CMake is a cross-platform Makefile generator that includes the testing tool CTest.
314+
CMake is a cross-platform Makefile generator that includes the testing tool CTest.
324315
To avoid cluttering or clobbering the source tree, our CMake setup requires that
325316
your build directory be any directory other than the top-level OpenCoarays
326317
source directory. In a bash shell, the following steps should build OpenCoarrays,
@@ -368,16 +359,16 @@ Advanced options (most users should not use these):
368359
### Make ###
369360

370361
Unlike the Makefiles that CMake generates automatically for the chosen
371-
platform, static Makefiles require a great deal more maintenance and
372-
are less portable. Also, the static Makefiles provided with
373-
OpenCoarrays lack several important capabilities. In particular, they
374-
will not build the tests; they will not generate the `caf` compiler wrapper
375-
that ensures correct linking and or `cafrun` program launcher that ensures
376-
support for advanced features such as Fortran 2015 failed images; they will
377-
not build the [opencoarrays] module that can be used to provide some Fortran
378-
2015 features with non-Fortran-2015 compilers; nor do the static Makefiles
379-
provide a `make install` option so you will need to manually move the
380-
resultant library from the build location to yoru chosen installation location.
362+
platform, static Makefiles require a great deal more maintenance and are
363+
less portable. Also, the static Makefiles provided in [src] lack several
364+
several important capabilities. In particular, they will not build the tests;
365+
they will not generate the `caf` compiler wrapper that ensures correct linking
366+
and `cafrun` program launcher that ensures support for advanced features such
367+
as Fortran 2015 failed images; they will not build the [opencoarrays] module
368+
that can be used to provide some Fortran 2015 features with non-Fortran-2015
369+
compilers; nor do the static Makefiles provide a `make install` option so you
370+
will need to manually move the resultant library from the build location to your chosen
371+
installation location.
381372

382373
If none of the installation methods mentioned higher in this document are
383374
work on your platform and if CMake is unavailable, build and install the
@@ -473,3 +464,4 @@ file.
473464
[OpenCoarrays Portfile]: https://www.macports.org/ports.php?by=name&substr=opencoarrays
474465
[WSL]: https://blogs.msdn.microsoft.com/commandline/2017/07/10/ubuntu-now-available-from-the-windows-store/
475466
[developer-scripts]: https://github.com/sourceryinstitute/OpenCoarrays/tree/master/developer-scripts
467+
[src]: https://github.com/sourceryinstitute/OpenCoarrays/tree/master/src

0 commit comments

Comments
 (0)