From 421132d35021b0675c16a9fe14bdeb4cdc238172 Mon Sep 17 00:00:00 2001 From: Eugen Wintersberger Date: Thu, 26 Oct 2017 19:31:04 +0200 Subject: [PATCH] Started with writing documentation --- doc/source/users_guide/CMakeLists.txt | 1 + doc/source/users_guide/index.rst | 5 +-- doc/source/users_guide/installing.rst | 47 +++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 doc/source/users_guide/installing.rst diff --git a/doc/source/users_guide/CMakeLists.txt b/doc/source/users_guide/CMakeLists.txt index efcc078a18..af96697707 100644 --- a/doc/source/users_guide/CMakeLists.txt +++ b/doc/source/users_guide/CMakeLists.txt @@ -1,4 +1,5 @@ set(SOURCES index.rst + installing.rst using.rst) add_sphinx_source(${SOURCES}) diff --git a/doc/source/users_guide/index.rst b/doc/source/users_guide/index.rst index 2e823b427f..4d2f70b094 100644 --- a/doc/source/users_guide/index.rst +++ b/doc/source/users_guide/index.rst @@ -2,11 +2,12 @@ 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 \ No newline at end of file diff --git a/doc/source/users_guide/installing.rst b/doc/source/users_guide/installing.rst new file mode 100644 index 0000000000..8f54608a7c --- /dev/null +++ b/doc/source/users_guide/installing.rst @@ -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 +------------ \ No newline at end of file