Skip to content

Commit 50cf119

Browse files
committed
Formatting cleanup of INSTALL.md
[ci skip]
1 parent 5c3e96a commit 50cf119

File tree

1 file changed

+23
-26
lines changed

1 file changed

+23
-26
lines changed

INSTALL.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,12 @@ OpenCoarrays source.
3838

3939
### macOS ###
4040

41-
[![homebrew][Homebrew badge]][braumeister link]
42-
43-
#### [Homebrew] ####
44-
41+
* [Homebrew]:
42+
[![homebrew][Homebrew badge]][braumeister link]
4543
This is the recommend OpenCoarrays installation method on macOS.
4644
Basic Homebrew installation steps:
4745

48-
```bash
46+
```
4947
brew update
5048
brew install opencoarrays
5149
```
@@ -55,14 +53,13 @@ OpenCoarrays source.
5553
with the GNU Compiler Collection ([GCC]). To install using the
5654
[`Brewfile`][Brewfile] with MPICH wrapping GCC, follow these steps:
5755

58-
```bash
56+
```
5957
brew tap homebrew/bundle
6058
brew update
6159
brew bundle
6260
```
6361

64-
#### [MacPorts] ####
65-
62+
* [MacPorts]:
6663
An unmaintained [OpenCoarrays Portfile] exists for the [MacPorts] package
6764
manager. Although the current OpenCoarrays contributors have no plans to
6865
update the portfile, new contributors are welcome to asssume the port
@@ -114,7 +111,7 @@ eb OpenCoarrays-1.9.0-gompi-2017a.eb --robot
114111
Once installed, use OpenCoarrays by loading the newly created environment
115112
module `OpenCoarrays/1.9.0-gompi-2017a`:
116113

117-
```bash
114+
```
118115
module load OpenCoarrays/1.9.0-gompi-2017a
119116
```
120117

@@ -141,7 +138,7 @@ already installed, and is available as a compiler to Spack. Otherwise,
141138
[add a new compiler to Spack]. Once installed, OpenCoarrays can be
142139
used by [loading the environment modules with Spack], e.g.
143140

144-
```bash
141+
```
145142
spack module loads --dependencies opencoarrays
146143
```
147144

@@ -152,7 +149,7 @@ spack module loads --dependencies opencoarrays
152149
Use the OpenCoarrays FreeBSD, Port to install OpenCoarrays by
153150
executing the following commands as root:
154151

155-
```bash
152+
```
156153
pkg install opencoarrays
157154
```
158155

@@ -182,7 +179,7 @@ OpenCoarrays by downloading and uncompressing our [latest release] and
182179
running our installation script in the top-level OpenCoarrays source
183180
directory (see above for the corresponding [Windows] script):
184181

185-
```bash
182+
```
186183
tar xvzf OpenCoarrays-x.y.z.tar.gz
187184
cd OpenCoarrays-x.y.z
188185
./install.sh
@@ -210,21 +207,21 @@ of flags. Each flag also has a single-character version not shown here.
210207
and installation files will be inside the OpenCoarrays source tree under
211208
prerequisites/installations:
212209

213-
```bash
210+
```
214211
./install.sh
215212
```
216213

217214
1. Install non-interactively by assuming a "yes" answer to all
218215
questions
219216

220-
```bash
217+
```
221218
./install.sh --yes-to-all
222219
```
223220

224221
1. Install with the specified compilers, overriding the default
225222
compilers:
226223

227-
```bash
224+
```
228225
./install.sh --with-fortran <path-to-gcc-bin>/gfortran \
229226
--with-cxx <path-to-gcc-bin>/g++ \
230227
--with-c <path-to-gcc-bin>/gcc
@@ -237,42 +234,42 @@ of flags. Each flag also has a single-character version not shown here.
237234

238235
1. Install only a specific prerequisite package (the default version):
239236

240-
```bash
237+
```
241238
./install.sh --package mpich
242239
```
243240

244241
1. Install a specific version of a prerequisite:
245242

246-
```bash
243+
```
247244
./install.sh --package cmake --install-version 3.7.0
248245
```
249246

250247
1. Download a prerequisite package (e.g., gcc/gfortran/g++ below) but
251248
don't build or install it:
252249

253-
```bash
250+
```
254251
./install.sh --only-download gcc
255252
```
256253

257254
1. Print the default URL, version, or download mechanism that the
258255
script will use for a given prerequisite package (e.g., mpich
259256
below) on this system:
260257

261-
```bash
258+
```
262259
./install.sh --print-url mpich
263260
./install.sh --print-version mpich
264261
./install.sh --print-downloader mpich
265262
```
266263

267264
1. Install a prerelease branch (e.g., trunk below) of the GCC repository:
268265

269-
```bash
266+
```
270267
./install.sh --package gcc --install-branch trunk
271268
```
272269

273270
1. Install to a specific location:
274271

275-
```bash
272+
```
276273
./install.sh --install-prefix /opt/gnu/
277274
```
278275

@@ -282,7 +279,7 @@ of flags. Each flag also has a single-character version not shown here.
282279

283280
1. Install a prerequisite package from a non-default URL:
284281

285-
```bash
282+
```
286283
./install.sh --package gcc \
287284
--from-url https://github.com/sourceryinstitute/gcc/archive/teams-20170919.tar.gz \
288285
--install-version teams-20170919
@@ -293,7 +290,7 @@ of flags. Each flag also has a single-character version not shown here.
293290

294291
1. Speed up a GCC build at a higher risk of a faild build:
295292

296-
```bash
293+
```
297294
./install.sh --package gcc --disable-bootstrap
298295
```
299296

@@ -302,7 +299,7 @@ of flags. Each flag also has a single-character version not shown here.
302299

303300
1. Speed up a GCC build with multithreading at a risk of a failed build:
304301

305-
```bash
302+
```
306303
./install.sh --package gcc --num-threads 4
307304
```
308305

@@ -348,7 +345,7 @@ your build directory be any directory other than the top-level OpenCoarays
348345
source directory. In a bash shell, the following steps should build OpenCoarrays,
349346
build the tests, run the tests, and report the test results:
350347

351-
```bash
348+
```
352349
tar xvzf opencoarrays.tar.gz
353350
cd opencoarrays
354351
mkdir opencoarrays-build
@@ -405,7 +402,7 @@ If none of the installation methods mentioned higher in this document are
405402
work on your platform and if CMake is unavailable, build and install the
406403
OpenCoarrays parallel runtime library as follows:
407404

408-
```bash
405+
```
409406
tar xvzf opencoarrays.tar.gz
410407
cd opencoarray/src
411408
make

0 commit comments

Comments
 (0)