Add build documentation

This commit is contained in:
Martijn Braam
2024-01-13 16:50:18 +01:00
parent 502409f82f
commit ad0309d484
2 changed files with 38 additions and 0 deletions

37
docs/building.rst Normal file
View File

@@ -0,0 +1,37 @@
Building
========
Libmegapixels is build through Meson. the Cmake files present in the repository are
only for IDE integration and does not install the binaries and required files.
The libmegapixels library depends on libconfig and linux-headers only.
The build steps for libmegapixels is just the normal Meson procedure for
building and installing a library:
.. code-block:: shell-session
$ git clone https://gitlab.com/megapixels-org/libmegapixels.git
Switch over to your favorite release branch after this
$ meson setup build
The Meson build system
Version: 1.3.1
... etcetera
$ cd build
$ meson compile
compiler output here...
$ sudo meson install
Installing libmegapixels.so.1.0.0 to /usr/local/lib
Installing megapixels-findconfig to /usr/local/bin
Installing megapixels-getframe to /usr/local/bin
Installing /..snip.../include/libmegapixels.h to /usr/local/include
Installing /..snip.../libmegapixels.pc to /usr/local/lib/pkgconfig
Installing /..snip.../config/pine64,pinephone.conf to /usr/local/share/megapixels/config
Installing symlink pointing to libmegapixels.so.1.0.0 to /usr/local/lib/libmegapixels.so.1
Installing symlink pointing to libmegapixels.so.1 to /usr/local/lib/libmegapixels.so
This will install the :code:`libmegapixels.so.1.0.0` library globally. This usually
ends up in :code:`/usr/local/lib` which is not by default in the search path for
libraries.
This will also install the libmegapixels utilities and bundled config files.

View File

@@ -14,5 +14,6 @@ media graph interface in Linux for ARM platforms with cameras.
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
building
overview overview
faq faq