examples: add README and example host file to mpi example

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

diff --git a/examples/mpi/README b/examples/mpi/README
new file mode 100644 (file)
index 0000000..3a6fb63
--- /dev/null
+++ b/examples/mpi/README
@@ -0,0 +1,15 @@
+# Examples using the MPI protocol
+
+As of now a single example is available at `src/mpi_simple.nit`.
+
+# Setting up the cluster
+
+* Install your distribution packages for OpenMPI, on Debian systems: `apt-get install openmpi-bin libopenmpi-dev`
+* Prepare the other nodes of the cluster by installing at least `openmpi-bin`.
+* List all the nodes in a file `hosts`, see `hosts.example`.
+
+# Compiling and running the examples
+
+* Compile the binary using `make`.
+* Copy the binary on each node of the cluster (or recompile it there).
+* Run with `make run`.

diff --git a/examples/mpi/hosts.example b/examples/mpi/hosts.example
new file mode 100644 (file)
index 0000000..c4b1b56
--- /dev/null
+++ b/examples/mpi/hosts.example
@@ -0,0 +1,5 @@
+# Example host list to use with OpenMPI (and its Nit wrapper)
+
+riph slots=8
+zako slots=4
+vawa slots=2