From c60069241f5ebd7c3a024435171efc58f3d01522 Mon Sep 17 00:00:00 2001 From: Kieran Bingham Date: Tue, 20 Nov 2018 08:18:42 -0800 Subject: Documentation: Introduce sphinx documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Utilise sphinx-build to generate documentation in HTML form, and populate with some initial content. An initial conf.py is generated from sphinx-quickstart and answering initial questions. Reviewed-by: Niklas Söderlund Signed-off-by: Kieran Bingham --- Documentation/index.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 Documentation/index.rst (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst new file mode 100644 index 00000000..c9b7c1cd --- /dev/null +++ b/Documentation/index.rst @@ -0,0 +1,30 @@ +libcamera +========= + +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. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + contributing + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` -- cgit v1.2.1