From 2ec24c31a4bc0fb44f6cabf68d4d8cde00486615 Mon Sep 17 00:00:00 2001 From: Simon Byrne Date: Tue, 7 Jan 2020 10:51:12 -0800 Subject: [PATCH] Improve README (#331) --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 224bfa757..988c358f5 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,18 @@ [![codecov.io](https://codecov.io/github/JuliaParallel/MPI.jl/coverage.svg?branch=master)](https://codecov.io/github/JuliaParallel/MPI.jl?branch=master) [![Coverage Status](https://coveralls.io/repos/JuliaParallel/MPI.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/JuliaParallel/MPI.jl?branch=master) -This is a basic [Julia] wrapper for the portable message passing -system Message Passing Interface ([MPI]). Inspiration is taken from -mpi4py, although we generally follow the C and not the C++ MPI API. -(The C++ MPI API is deprecated.) - -[Julia]: http://julialang.org/ -[MPI]: http://www.mpi-forum.org/ -[mpi4py]: http://mpi4py.scipy.org +This provides [Julia](http://julialang.org/) interface to the Message Passing Interface ([MPI](http://www.mpi-forum.org/)), roughly inspired by [mpi4py](http://mpi4py.scipy.org). + +Please see the [documentation](https://juliaparallel.github.io/MPI.jl/stable/) for instructions on [installation](https://juliaparallel.github.io/MPI.jl/stable/installation/) and [usage](https://juliaparallel.github.io/MPI.jl/stable/usage/). + +# Help and discussion + +For help and discussion, we suggest asking on the following venues: + - ["Julia at Scale" topic on the Julia Discourse](https://discourse.julialang.org/c/domain/parallel/34) + - #distributed channel on the [Julia Slack](https://julialang.slack.com/) (visit [slackinvite.julialang.org](https://slackinvite.julialang.org/) to join). + +# Contributing + +Contributions are encouraged. In particular, MPI provides several hundred functions, only a small number of which are currently exposed. If there are additional functions you would like to use, please open an [issue](https://github.com/JuliaParallel/MPI.jl/issues) or [pull request](https://github.com/JuliaParallel/MPI.jl/pulls). + +Additional examples and documentation improvements are also very welcome.