Skip to content

Commit

Permalink
Merge branch 'master' of [email protected]:ess-dmsc/h5cpp.git
Browse files Browse the repository at this point in the history
Conflicts:
	doc/source/users_guide/CMakeLists.txt
	doc/source/users_guide/index.rst
  • Loading branch information
eugenwintersberger committed Nov 1, 2017
2 parents 9d50abd + 49736a0 commit 83bf2c2
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 2 deletions.
1 change: 1 addition & 0 deletions doc/source/users_guide/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
set(SOURCES index.rst
installing.rst
using.rst
files.rst
groups.rst
Expand Down
5 changes: 3 additions & 2 deletions doc/source/users_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
Users guide
===========

This chapter will contain the userse guide for the C++ wrapper.
This chapter will contain the users guide for the C++ wrapper.
Still need to add a table of contents here.


.. toctree::
:maxdepth: 1


installing
using
overview
files
Expand Down
47 changes: 47 additions & 0 deletions doc/source/users_guide/installing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
======================
Installing the library
======================

This chapter describes the installation of *h5cpp* from sources.

Requirements
------------

In order to build the code you need

* a C++ compiler with reasonable C++11 support (gcc>=4.9,Micrsoft Developer Studio >= 2015)
* the Boost libraries
* the HDF5 C library
* googletest to build the unit tests
* sphinx (with python) and doxygen for the documentation build
* cmake >= 3.0

Getting the code
----------------

You can either obtain one of the release tar balls from the `release site`_ of the
project on GitHub or clone the master branch of the repository.
In the first case you get a source tree with

.. code-block:: bash
$ tar -xzf h5cpp-*.tar.gz
while in the latter you may want to use

.. code-block:: bash
$ git clone https://github.com/ess-dmsc/h5cpp.git
*h5cpp* uses :program:`CMake` to build the code in which case an out of
source build is recommended.

_release site: https://github.com/ess-dmsc/h5cpp/releases



Building and testing
--------------------

Installation
------------

0 comments on commit 83bf2c2

Please sign in to comment.