Skip to content

Commit accd990

Browse files
Added section how to build binaries and documentation
1 parent 0a72717 commit accd990

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.rst

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,8 @@ the build system
1919
Building the code on Linux
2020
==========================
2121

22-
Configuration
23-
-------------
24-
2522
Enabling a physical file formats
26-
++++++++++++++++++++++++++++++++
23+
--------------------------------
2724

2825
By default the NAPI is only built with HDF5 support. You can explicit switch on
2926
a particular file format by defining the appropriate CMake variable during
@@ -104,3 +101,26 @@ additional build requirements. These are
104101
As one cannot select an individual program to be included in the build, all
105102
these build dependencies must be satisified when ``ENABLE_APPS`` is set to
106103
``ON`` in order for the build to succeed.
104+
105+
Running the build
106+
-----------------
107+
108+
To build the library and program binaries simply use
109+
110+
.. code-block:: bash
111+
112+
$ make
113+
114+
and for installation
115+
116+
.. code-block:: bash
117+
118+
$ make install
119+
120+
This procedure installs the binaries, header files, and the man pages for the
121+
programs (if configured to build them). To build the API documentation use
122+
123+
.. code-block:: bash
124+
125+
$ make html
126+
$ make install-html

0 commit comments

Comments
 (0)