Skip to content

Commit ff44ca3

Browse files
committed
README: Add a "quick start" section.
Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
1 parent 078dc0a commit ff44ca3

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,59 @@ Much, much more information is also available in the Open MPI FAQ:
6363

6464
===========================================================================
6565

66+
Quick start
67+
-----------
68+
69+
In many cases, Open MPI can be built and installed by simply
70+
indicating the installation directory on the command line:
71+
72+
$ tar xf openmpi-<version>.tar.bz2
73+
$ cd openmpi-<version>
74+
$ ./configure --prefix=<path> |& tee config.out
75+
...lots of output...
76+
$ make -j 8 |& tee make.out
77+
...lots of output...
78+
$ make install |& tee install.out
79+
...lots of output...
80+
81+
Note that there are many, many configuration options to the
82+
"./configure" step. Some of them may be needed for your particular
83+
environmnet; see below for desciptions of the options available.
84+
85+
If your installation prefix path is not writable by a regular user,
86+
you may need to use sudo or su to run the "make install" step. For
87+
example:
88+
89+
$ sudo make install |& tee install.out
90+
[sudo] password for jsquyres: <enter your password here>
91+
...lots of output...
92+
93+
Finally, note that VPATH builds are fully supported. For example:
94+
95+
$ tar xf openmpi-<version>.tar.bz2
96+
$ cd openmpi-<version>
97+
$ mkdir build
98+
$ cd build
99+
$ ../configure --prefix=<path> |& tee config.out
100+
...etc.
101+
102+
The rest of this README file contains:
103+
104+
- General release notes about Open MPI, including information about
105+
platform, compiler, and run-time support, MPI and OpenSHMEM
106+
functionality, network support, and MPI extensions.
107+
- Detailed information on building and installing Open MPI.
108+
- Open MPI version and library numbering policies, including how those
109+
are related to backwards compatibility guarantees.
110+
- Information on how to both query and validate your Open MPI
111+
installation.
112+
- Description of Open MPI extensions.
113+
- Examples showing how to compile and run Open MPI applications.
114+
- Summary information on the various plugin frameworks inside Open
115+
MPI and OpenSHMEM.
116+
117+
===========================================================================
118+
66119
The following abbreviated list of release notes applies to this code
67120
base as of this writing (March 2017):
68121

0 commit comments

Comments
 (0)