Skip to content

Commit 37f2d98

Browse files
mtouzotnaushir
authored andcommitted
RASPBERRYPI ONLY: Update README to follow Raspberry Pi documentation
1 parent 16142dc commit 37f2d98

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.rst

+35-3
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,47 @@ systems, including traditional Linux distributions, ChromeOS and Android.
2828
Getting Started
2929
---------------
3030

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

33+
If you run ``Raspberry Pi OS Lite``, begin by installing the following packages:
34+
3335
.. code::
3436
35-
git clone https://git.libcamera.org/libcamera/libcamera.git
37+
sudo apt install -y python-pip git python3-jinja2
38+
39+
First, install the following ``libcamera`` dependencies:
40+
.. code::
41+
42+
sudo apt install -y libboost-dev
43+
sudo apt install -y libgnutls28-dev openssl libtiff-dev pybind11-dev
44+
sudo apt install -y qtbase5-dev libqt5core5a libqt5widgets
45+
sudo apt install -y meson cmake
46+
sudo apt install -y python3-yaml python3-ply
47+
sudo apt install -y libglib2.0-dev libgstreamer-plugins-base1.0-dev
48+
49+
Now we're ready to build ``libcamera`` itself.
50+
51+
Download a local copy of Raspberry Pi's fork of ``libcamera`` from GitHub, before building and installing freshly-build binary:
52+
53+
.. code::
54+
55+
git clone https://github.com/raspberrypi/libcamera.git
3656
cd libcamera
37-
meson setup build
57+
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
3858
ninja -C build install
3959
60+
You can disable the ``gstreamer`` plugin by replacing ``-Dgstreamer=enabled`` with ``-Dgstreamer=disabled`` during the ``meson`` build configuration.
61+
If you disable ``gstreamer``, there is no need to install the ``libglib2.0-dev`` and ``libgstreamer-plugins-base1.0-dev`` dependencies.
62+
63+
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.
64+
This should prevent the build from exceeding available memory on devices like the Raspberry Pi Zero and the Raspberry Pi 3.
65+
66+
``libcamera`` does not yet have a stable binary interface. Always build ``rpicam-apps`` after you build ``libcamera``.
67+
68+
You can find more informations at `Raspberry Pi libcamera documentation`_ pages.
69+
70+
.. _Raspberry Pi libcamera documentation: https://www.raspberrypi.com/documentation/computers/camera_software.html
71+
4072
Dependencies
4173
~~~~~~~~~~~~
4274

0 commit comments

Comments
 (0)