diff options
| -rw-r--r-- | Documentation/index.rst | 19 | ||||
| -rw-r--r-- | Documentation/meson.build | 1 | ||||
| -rw-r--r-- | README.rst | 17 |
3 files changed, 20 insertions, 17 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst index e481f081..ec222210 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,20 +1,5 @@ -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. - +.. Front page matter is defined in the project README file. +.. include:: ../README.rst .. toctree:: :maxdepth: 2 diff --git a/Documentation/meson.build b/Documentation/meson.build index b1720b05..a560d02a 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -41,6 +41,7 @@ endif if sphinx.found() docs_sources = [ + '../README.rst', 'coding-style.rst', 'conf.py', 'contributing.rst', @@ -4,6 +4,23 @@ **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. + +Getting Started +--------------- + To build and install: :: |