Working on SoftISP
Find a file
Laurent Pinchart cf596d8dfa Documentation: Hide the Getting Started information
The Getting Started information makes little sense on the generated
documentation, as a developer with documentation compiled from a local
libcamera source tree has already got started. We however want to keep
the information in the top-level README.rst as it is useful there.

In order to hide the Getting Started information from the front page
while keeping it in README.rst, add comments to delimitate sections of
README.rst, and include only a subset of the file in the front page.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
2019-10-23 17:41:09 +03:00
Documentation Documentation: Hide the Getting Started information 2019-10-23 17:41:09 +03:00
include libcamera: Standardise on C compatibility headers 2019-10-23 17:39:39 +03:00
licenses licenses: add Apache-2.0 license 2019-08-12 10:34:13 +02:00
package/gentoo/media-libs/libcamera libcamera: controls: Auto-generate control_ids.h and control_ids.cpp 2019-10-05 20:02:51 +03:00
src libcamera: Standardise on C compatibility headers 2019-10-23 17:39:39 +03:00
test libcamera: Standardise on C compatibility headers 2019-10-23 17:39:39 +03:00
utils utils: checkstyle.py: Add include checker 2019-10-23 17:12:34 +03:00
.clang-format clang-format: Don't indent namespaces 2019-09-23 09:50:08 +03:00
.gitignore git: Add .gitignore file 2018-12-14 13:23:07 +00:00
meson.build meson: Rename 'tests' option to 'test' 2019-08-22 19:35:54 +03:00
meson_options.txt meson: Rename 'tests' option to 'test' 2019-08-22 19:35:54 +03:00
README.rst Documentation: Hide the Getting Started information 2019-10-23 17:41:09 +03:00

.. section-begin-libcamera

===========
 libcamera
===========

**A complex camera support library for Linux, Android, and ChromeOS**

Cameras are complex devices that need heavy hardware image processing
operations. Control of the processing is based on advanced algorithms that must
run on a programmable processor. This has traditionally been implemented in a
dedicated MCU in the camera, but in embedded devices algorithms have been moved
to the main CPU to save cost. Blurring the boundary between camera devices and
Linux often left the user with no other option than a vendor-specific
closed-source solution.

To address this problem the Linux media community has very recently started
collaboration with the industry to develop a camera stack that will be
open-source-friendly while still protecting vendor core IP. libcamera was born
out of that collaboration and will offer modern camera support to Linux-based
systems, including traditional Linux distributions, ChromeOS and Android.

.. section-end-libcamera
.. section-begin-getting-started

Getting Started
---------------

To build and install:

::

  meson build
  cd build
  ninja
  ninja install

Dependencies
~~~~~~~~~~~~

The following Debian/Ubuntu packages are required for building libcamera.
Other distributions may have differing package names:

A C++ toolchain: [required]
	Either {g++, clang}

for libcamera: [required]
	meson ninja-build python3-yaml

for device hotplug enumeration: [optional]
	pkg-config libudev-dev

for qcam: [optional]
	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5

for documentation: [optional]
	python3-sphinx doxygen

.. section-end-getting-started