From a99a975b1e248070137e4de68809400032087dbf Mon Sep 17 00:00:00 2001 From: Michael Gilroy Date: Tue, 20 Jun 2017 14:37:41 +0000 Subject: updated README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 10c1c1f..ff1032a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,10 @@ -# gentoo-mpi -Google Summer of Code 2017 Project with the Gentoo Foundation +# Gentoo MPI Overlay (Google Summer of Code 2017) + +## Description +A collection of tools for assisting the build process for MPI software in order to support installations of multiple MPI implementations and their respective versions. This should serve as a set of standards for MPI ebuild writers, and make it as easy as possible to write and maintain MPI ebuilds. + +## mpi-providers.eclass +This is to support multiple MPI implementation's installations in parallel. Remove any "SLOT=" assignment from the ebuild, as this is handled by mpi-providers. Append 'sysconfdir="$(mpi-providers\_sysconfdir)" \' to your econf arguments. In the install phase, insert "mpi-providers\_safe\_mv" to the end of the installation function, as this will move the installation destination in such a way to support parallel installs in /usr/lib/mpi. + +## mpi-select.eclass +This allows other mpi software to be built with multiple MPI implementations. For example, if you want to build HPL with mpich _and_ openmpi, mpi-select will build mpich and openmpi against HPL. -- cgit v1.2.3