-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of [email protected]:ess-dmsc/h5cpp.git
Conflicts: doc/source/users_guide/CMakeLists.txt doc/source/users_guide/index.rst
- Loading branch information
Showing
3 changed files
with
51 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
------------ |