Skip to content

Commit 933a3a4

Browse files
committed
Fix some language in INSTALL{,.md}
- Remove disparaging remarks about Windows - Replace CMake section of INSTALL.md with concise text and pointers to INSTALL and the developer/maintainer summary
1 parent 8e0922f commit 933a3a4

File tree

2 files changed

+8
-48
lines changed

2 files changed

+8
-48
lines changed

INSTALL

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
OpenCoarrays developer/quickstart guide
1+
Developer/quickstart installation guide
22
=======================================
33

4-
This guide assumes that the reader is on a *nix operating system---Windows
5-
is *NOT* officially supported.
4+
This guide assumes that the reader is on a *nix operating system.
65

76
Please report any issues encountered or bugs to:
87

INSTALL.md

Lines changed: 6 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -383,51 +383,12 @@ opencoarrays
383383

384384
### CMake ###
385385

386-
On most platforms, the [`install.sh`] script ultimately invokes [CMake] after performing
387-
numerous checks, customizations, and installations of any missing prerequisites.
388-
Advanced users who prefer to invoke CMake directly may do so as described here.
389-
CMake is a cross-platform Makefile generator that includes the testing tool CTest.
390-
To avoid cluttering or clobbering the source tree, our CMake setup requires that
391-
your build directory be any directory other than the top-level OpenCoarays
392-
source directory. In a bash shell, the following steps should build OpenCoarrays,
393-
build the tests, run the tests, and report the test results:
394-
395-
```
396-
tar xvzf opencoarrays.tar.gz
397-
cd opencoarrays
398-
mkdir opencoarrays-build
399-
cd opencoarrays-build
400-
CC=gcc FC=gfortran cmake .. -DCMAKE_INSTALL_PREFIX=${HOME}/packages/
401-
make
402-
ctest
403-
make install
404-
```
405-
406-
where the the first part of the cmake line sets the CC and FC
407-
environment variables and the final part of the same line defines the
408-
installation path as the `packages` directory in the current user's
409-
`$HOME` directory. Please report any test failures via the
410-
OpenCoarrays [Issues] page. Please note that you need a recent
411-
GCC/GFortran, and a recent MPI-3 implementation. If CMake is having
412-
trouble finding the MPI implementation, or is finding the wrong MPI
413-
implementation, you can try setting the `MPI_HOME` environment
414-
variable to point to the installation you wish to use. If that fails,
415-
you can also try passing the
416-
`-DMPI_Fortran_COMPILER=/path/to/mpi/fortran/wrapper/script` and
417-
`-DMP_C_COMPILER=/path/to/mpi/c/wrapper/script` options to CMake.
418-
419-
Advanced options (most users should not use these):
420-
421-
```CMake
422-
-DMPI_HOME=/path/to/mpi/dir # try to force CMake to find your preferred MPI implementation
423-
# OR
424-
-DMPI_C_COMPILER=/path/to/c/wrapper
425-
-DMPI_Fortran_COMPILER=/path/to/fortran/wrapper
426-
427-
-DHIGH_RESOLUTION_TIMER=ON # enables timers that tick once per clock cycle
428-
-DCOMPILER_PROVIDES_MPI # is set automatically when building with-the Cray
429-
# Compiler Environment
430-
```
386+
On most platforms, the [`install.sh`] script ultimately invokes [CMake] after
387+
performing numerous checks, customizations, and installations of any missing
388+
prerequisites. Users wishing to install OpenCoarrays directly with CMake should
389+
have a look at the documentation in the [`./INSTALL`] file if they encounter
390+
issues or need further guidance. A brief summary is also given at the top of
391+
this document [here][Developer Build and Install].
431392

432393
[top]
433394

0 commit comments

Comments
 (0)