Merge pull request #120 from ax3l/doc-moreLinks

Docs: More Links Dependencies
openPMD · Apr 10, 2018 · 09f3a48 · 09f3a48
2 parents 60a5381 + 763d1ca
commit 09f3a48
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -85,30 +85,33 @@ for k, i in series.iterations.items():
 ### More!
 
 Curious?
-Our manual shows full [read & write examples](https://openpmd-api.readthedocs.io/en/latest/usage/firststeps.html), both serial an MPI-parallel!
+Our manual shows full [read & write examples](https://openpmd-api.readthedocs.io/en/latest/usage/firststeps.html), both serial and MPI-parallel!
 
 ## Dependencies
 
 Required:
 * CMake 3.10.0+
 * Boost 1.62.0+: `filesystem`, `system`
+* C++11 capable compiler, e.g. g++ 4.9+, clang 3.9+
 
 Shipped internally:
 * [MPark.Variant](https://github.com/mpark/variant) 1.3.0+
 * [Catch2](https://github.com/catchorg/Catch2) 2.2.1+
 
 Optional I/O backends:
-* HDF5 1.8.6+
-* ADIOS 1.10+ (*not yet implemented*)
-* ADIOS 2.1+ (*not yet implemented*)
+* [HDF5](https://support.hdfgroup.org/HDF5) 1.8.6+
+* [ADIOS](https://www.olcf.ornl.gov/center-projects/adios) 1.10+ (*not yet implemented*)
+* [ADIOS](https://github.com/ornladios/ADIOS2) 2.1+ (*not yet implemented*)
 
 while those can be build either with or without:
 * MPI 2.3+, e.g. OpenMPI or MPICH2
 
 Optional language bindings:
 * Python:
   * Python 3.X+
-  * pybind11 2.3.0+
+  * pybind11 2.2.1+
+
+* Python (*not yet implemented*):
   * mpi4py?
   * numpy-dev?
   * xtensor-python 0.17.0+?

diff --git a/docs/source/dev/dependencies.rst b/docs/source/dev/dependencies.rst
@@ -5,14 +5,15 @@ Build Dependencies
 
 .. sectionauthor:: Axel Huebl
 
-``openPMD-api`` depends on a series of third-party libraries.
+``openPMD-api`` depends on a series of third-party projects.
 These are currently:
 
 Required
 --------
 
 * CMake 3.10.0+
 * Boost 1.62.0+: ``filesystem``, ``system``
+* C++11 capable compiler, e.g. g++ 4.9+, clang 3.9+
 
 Shipped internally
 ------------------
@@ -25,9 +26,9 @@ The following libraries are shipped internally for convenience:
 Optional: I/O backends
 ----------------------
 
-* HDF5 1.8.6+
-* ADIOS 1.10+ (*not yet implemented*)
-* ADIOS 2.1+ (*not yet implemented*)
+* `HDF5 <https://support.hdfgroup.org/HDF5>`_ 1.8.6+
+* `ADIOS <https://www.olcf.ornl.gov/center-projects/adios>`_ 1.10+ (*not yet implemented*)
+* `ADIOS <https://github.com/ornladios/ADIOS2>`_ 2.1+ (*not yet implemented*)
 
 while those can be build either with or without:
 
@@ -39,7 +40,10 @@ Optional: language bindings
 * Python:
 
   * Python 3.X+
-  * pybind11 2.3.0+
+  * pybind11 2.2.1+
+
+* Python (*not yet implemented*):
+
   * mpi4py?
   * numpy-dev?
   * xtensor-python 0.17.0+?