README.md
1# libmatroska
2a C++ libary to parse and create Matroska files
3
4# Building and installing
5
6## Building and installing the library
7
8libmatroska is based on `cmake`. It requires a C++ compiler as well as
9[libebml](https://github.com/Matroska-Org/libebml). This means that
10the normal build process consists of the usual steps:
11
121. Create a build directory: `mkdir build ; cd build`
132. Generate the make file: `cmake ..`
143. Compilation: `make`
154. Installation (run this as root): `make install`
16
17## Customizing what's build with options
18
19By default only a static library is built.
20
21This library supports the usual `cmake` options for specifying
22installation paths (e.g. `-DCMAKE_INSTALL_PREFIX=/opt/libmatroska`). The
23following additional `cmake` options are supported:
24
25* `-DEbml_DIR=/path/to/libebml` — if `libebml` was installed in a
26 non-default location, you have to tell `cmake` where to find
27 it. Point this variable to the directory containing the
28 `EbmlConfig.cmake` file.
29* `-DDISABLE_PKGCONFIG=YES` — don't generate and install the
30 `libebml.pc` package configuration module for `pkg-config`
31* `-DDISABLE_CMAKE_CONFIG=YES` — don't generate and install the
32 package configuration module for `cmake`
33* `-DBUILD_SHARED_LIBS=YES` — build the shared library instead of the
34 static one (default: no)
35
36## Code of conduct
37
38Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
39