Skip to content

Commit b5c1387

Browse files
author
Damian Rouson
committed
Add Markdown README.md with installation info
1 parent b58758c commit b5c1387

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

README.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
Overview
2+
========
3+
This repository exists as a staging ground for developing candidate
4+
contributions to the GNU Compiler Collection ([GCC]).
5+
6+
Candidate features currently on this site are listed below. The checked items indicate features
7+
that are deemed sufficiently functional submitted to the relevant GCC developer mailing list for review.
8+
We welcome user feedback from testing these features. Unchecked itmes are insufficiently mature to
9+
submit to GCC. We welcome code via [pull request] for any listed features or other unsupported
10+
features of the draft Fortran 2015 standard:
11+
12+
- [X] The [teams branch] with experimental support for Fortran 2015 teams.
13+
- [X] The [download-opencoarrays-mpich branch] modifying GCC's prequisites download script
14+
to add [OpenCoarrays] and [MPICH] to the list of downloade software.
15+
- [ ] The [issue-#6-iso-fortran-binding-h branch] providing gthe Fortran 2015 `iso_fortran_binding.h` file.
16+
17+
Installation
18+
============
19+
This fork's [releases] are produced from the [teams branch], which expect will be of
20+
most interest to users. We recommend building releses usin the [OpenCoarrays]
21+
installation script as follows:
22+
```bash
23+
git clone https://github.com/sourceryinstitute/opencoarrays
24+
cd oppencoarrays
25+
./install.sh --package gcc \
26+
--from-url https://github.com/sourceryinstitute/gcc/archive/<release-tag>.tar.gz \
27+
--install-version teams-20170921
28+
```
29+
where <version-number> and <release-tag> must be replaced with the appropriate strings such as
30+
1.9.2 and teams-20170921, respectively. The final command above peforms the safest but slowest
31+
build, which could take several hours to complete. For a speedier build, add the `--disable-bootstrap`,
32+
which might fail if the GCC you are using to build is too old. Also, for an interactive build,
33+
add `--yes-to-all` to instruct the installer to assume affirmative answers to any queries. If successful,
34+
the above steps will install GCC in the prerequisites/installations subdirectory. To see additional
35+
installation options, including choosing another installation path, execute `./install.sh --help`.
36+
37+
For access to any Fortran 2015 parallel features, including teams and failed images, build the [MPICH]
38+
and the [opencoarrays-teams branch]:
39+
of OpenCoarrays:
40+
```bash
41+
git checkout opencoarrays-teams
42+
export LD_LIBRARY_PATH=<gcc-fork-install-path>/lib64:$LD_LIBRARY_PATH
43+
./install.sh --package mpich \
44+
--with-fortran <gcc-fork-install-path>/bin/gfortarn \
45+
--with-c <gcc-fork-install-path>/bin/gcc \
46+
--with-cpp <gcc-fork-install-path>/bin/g++
47+
./install.sh \
48+
--with-mpi <mpich-install-path>
49+
```
50+
with appropriate substitutions for the values between angular brackdets (<...>). Please report
51+
any problems with the above steps on our [issues page].
52+
53+
54+
[GCC mirror] README
55+
===================
56+
57+
This directory contains the GNU Compiler Collection (GCC).
58+
59+
The GNU Compiler Collection is free software. See the files whose
60+
names start with COPYING for copying permission. The manuals, and
61+
some of the runtime libraries, are under different terms; see the
62+
individual source files for details.
63+
64+
The directory INSTALL contains copies of the installation information
65+
as HTML and plain text. The source of this information is
66+
gcc/doc/install.texi. The installation information includes details
67+
of what is included in the GCC sources and what files GCC installs.
68+
69+
See the file gcc/doc/gcc.texi (together with other files that it
70+
includes) for usage and porting information. An online readable
71+
version of the manual is in the files gcc/doc/gcc.info*.
72+
73+
See http://gcc.gnu.org/bugs/ for how to report bugs usefully.
74+
75+
Copyright years on GCC source files may be listed using range
76+
notation, e.g., 1987-2012, indicating that every year in the range,
77+
inclusive, is a copyrightable year that could otherwise be listed
78+
individually.
79+
80+
[GCC mirror]: https://github.com/gcc-mirror/gcc
81+
[GCC]: https://gcc.gnu.org/gcc
82+
[OpenCoarrays]: https://www.opendcoarrays.org
83+
[MPICH]: https://www.mpich.org
84+
[teams branch]: https://github.com/sourceryinstitute/gcc/tree/teams
85+
[issue-#6-iso-fortran-binding-h branch]: https://github.com/sourceryinstitute/gcc/tree/issue-#6-iso-fortran-binding-h
86+
[download-opencoarrays-mpich branch]: https://github.com/sourceryinstitute/gcc/tree/download-opencoarrays-mpich
87+
[releases] https://github.com/sourceryinstitute/gcc/releases/
88+
[issues page] https://github.com/sourceryinstitute/gcc/issues/
89+
[opencoarrays-teams branch]: https://github.com/sourceryinstitute/opencoarrays/tree/opencoarrays-teams

0 commit comments

Comments
 (0)