Skip to content

Commit 2fc9ce1

Browse files
mtouzotnaushir
authored andcommitted
RASPBERRYPI ONLY: Update README to follow Raspberry Pi documentation
1 parent e86d034 commit 2fc9ce1

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.rst

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,47 @@ systems, including traditional Linux distributions, ChromeOS and Android.
2525
Getting Started
2626
---------------
2727

28-
To fetch the sources, build and install:
28+
Only build ``libcamera`` from scratch if you need custom behaviour or the latest features that have not yet reached ``apt`` repositories.
2929

30+
If you run ``Raspberry Pi OS Lite``, begin by installing the following packages:
31+
3032
.. code::
3133
32-
git clone https://git.libcamera.org/libcamera/libcamera.git
34+
sudo apt install -y python-pip git python3-jinja2
35+
36+
First, install the following ``libcamera`` dependencies:
37+
.. code::
38+
39+
sudo apt install -y libboost-dev
40+
sudo apt install -y libgnutls28-dev openssl libtiff-dev pybind11-dev
41+
sudo apt install -y qtbase5-dev libqt5core5a libqt5widgets
42+
sudo apt install -y meson cmake
43+
sudo apt install -y python3-yaml python3-ply
44+
sudo apt install -y libglib2.0-dev libgstreamer-plugins-base1.0-dev
45+
46+
Now we're ready to build ``libcamera`` itself.
47+
48+
Download a local copy of Raspberry Pi's fork of ``libcamera`` from GitHub, before building and installing freshly-build binary:
49+
50+
.. code::
51+
52+
git clone https://github.com/raspberrypi/libcamera.git
3353
cd libcamera
34-
meson setup build
54+
meson setup build --buildtype=release -Dpipelines=rpi/vc4,rpi/pisp -Dipas=rpi/vc4,rpi/pisp -Dv4l2=true -Dgstreamer=enabled -Dtest=false -Dlc-compliance=disabled -Dcam=disabled -Dqcam=disabled -Ddocumentation=disabled -Dpycamera=enabled
3555
ninja -C build install
3656
57+
You can disable the ``gstreamer`` plugin by replacing ``-Dgstreamer=enabled`` with ``-Dgstreamer=disabled`` during the ``meson`` build configuration.
58+
If you disable ``gstreamer``, there is no need to install the ``libglib2.0-dev`` and ``libgstreamer-plugins-base1.0-dev`` dependencies.
59+
60+
On devices with 1GB of memory or less, the build may exceed available memory. Append the ``-j 1`` flag to ``ninja`` commands to limit the build to a single process.
61+
This should prevent the build from exceeding available memory on devices like the Raspberry Pi Zero and the Raspberry Pi 3.
62+
63+
``libcamera`` does not yet have a stable binary interface. Always build ``rpicam-apps`` after you build ``libcamera``.
64+
65+
You can find more informations at `Raspberry Pi libcamera documentation`_ pages.
66+
67+
.. _Raspberry Pi libcamera documentation: https://www.raspberrypi.com/documentation/computers/camera_software.html
68+
3769
Dependencies
3870
~~~~~~~~~~~~
3971

0 commit comments

Comments
 (0)