diff options
author | Kieran Bingham <kieran.bingham@ideasonboard.com> | 2018-11-20 08:18:42 -0800 |
---|---|---|
committer | Kieran Bingham <kieran.bingham@ideasonboard.com> | 2018-11-28 11:10:11 +0000 |
commit | c60069241f5ebd7c3a024435171efc58f3d01522 (patch) | |
tree | fcab18f3daad55b71fddc5c7f61b24d28ec9672e /Documentation/index.rst | |
parent | ce1c86c10cba48a1acc9b7ee745efb383077711a (diff) |
Documentation: Introduce sphinx documentation
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 <niklas.soderlund@ragnatech.se>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'Documentation/index.rst')
-rw-r--r-- | Documentation/index.rst | 30 |
1 files changed, 30 insertions, 0 deletions
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` |