From patchwork Wed Aug 14 09:58:15 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 1806 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id A9B2761918 for ; Wed, 14 Aug 2019 11:58:22 +0200 (CEST) Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id DFBD233C; Wed, 14 Aug 2019 11:58:21 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1565776702; bh=YPXf7itz9aJaX0jKqOI7YyNErlObLsZypjuUDjzk980=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=kDOdTgN6dByX7WwgCLdpNvTCGXYcKF8qj110Qzxd9dg2r/sRX4fDbr6+dgFmn/qC2 oDsZJqKy22x3Taoush6gfYIImicV1syF3bjPEMvLHa3yc5bzR3/CaoNSh2W3KYhugA 1LTzUq5WmnW/4NkZDUbofCMOtTsejOK7WeBM5fcY= From: Kieran Bingham To: LibCamera Devel Date: Wed, 14 Aug 2019 10:58:15 +0100 Message-Id: <20190814095817.13625-2-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190814095817.13625-1-kieran.bingham@ideasonboard.com> References: <20190814095817.13625-1-kieran.bingham@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 1/3] readme: Convert from Markdown to RST X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Aug 2019 09:58:23 -0000 The Documentation and top-level README both serve to provide information to new developers and users of libcamera. Currently our README.md is sparse, and should be expanded with more useful information such as build requirements as well as compilation directions. Any information provided in the README also serves a purpose in the main documentation and website and could be a cause of duplicated content. To allow direct integration of the top level README document into our sphinx documenation (and thus the libcamera.org website) convert the README.md into ReSTructured text format. Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart Reviewed-by: Niklas Söderlund --- README.md | 9 --------- README.rst | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 9 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 45ae3a41062e..000000000000 --- a/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# libcamera: A complex camera support library for Linux, Android, and ChromeOS - -To build and install: -``` - meson build - cd build - ninja - ninja install -``` diff --git a/README.rst b/README.rst new file mode 100644 index 000000000000..9a8261ac8502 --- /dev/null +++ b/README.rst @@ -0,0 +1,14 @@ +=========== + libcamera +=========== + +**A complex camera support library for Linux, Android, and ChromeOS** + +To build and install: + +:: + + meson build + cd build + ninja + ninja install From patchwork Wed Aug 14 09:58:16 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 1809 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id F235E61919 for ; Wed, 14 Aug 2019 11:58:22 +0200 (CEST) Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 3DF8A592; Wed, 14 Aug 2019 11:58:22 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1565776702; bh=OMwm+a3kiTzp0H2G+OAWiQPCg7it8m+zVFmqIe1+p4Q=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=XmJ6w8PgpIS8UT6eY1B/ZHy20Ws/iG9kpYthEqdXbUyczOAcblz7zdpxB34Q5VHmL FNE0zmTm+MXJsYqL5RRsQNhPmQGLtwzwfoEj5MVf8oFMCokx8GsDEG8N/EJOSguGad gtAoOkOPEgTqE/fkgvHbFnKJrPUHBpW2KHQCb0PM= From: Kieran Bingham To: LibCamera Devel Date: Wed, 14 Aug 2019 10:58:16 +0100 Message-Id: <20190814095817.13625-3-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190814095817.13625-1-kieran.bingham@ideasonboard.com> References: <20190814095817.13625-1-kieran.bingham@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 2/3] readme: Move index page content to README X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Aug 2019 09:58:23 -0000 Move the introduction content from the index.rst to the README.rst so that it can also be found quickly from the top level. Include the README.rst directly into the index.rst to continue serving it as the front page material. Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart Reviewed-by: Niklas Söderlund --- Documentation/index.rst | 19 ++----------------- Documentation/meson.build | 1 + README.rst | 17 +++++++++++++++++ 3 files changed, 20 insertions(+), 17 deletions(-) diff --git a/Documentation/index.rst b/Documentation/index.rst index e481f081f9a1..ec2222108e8a 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 b1720b05f5ee..a560d02abfa5 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', diff --git a/README.rst b/README.rst index 9a8261ac8502..0f64e076a9c0 100644 --- a/README.rst +++ b/README.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: :: From patchwork Wed Aug 14 09:58:17 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 1808 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 00EEF6191A for ; Wed, 14 Aug 2019 11:58:23 +0200 (CEST) Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 9080EE86; Wed, 14 Aug 2019 11:58:22 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1565776702; bh=0veNGpVs0jmDMKVV+v07Qrgob8wXaJ1WiVwOYJI0XLE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=RSltJNoHY4y+D09s3cmp4zmItMDDX3L/LgMDtZPKyO1DfQ38NzUlCPZQnhCfulpkB 6+CKwtsVDE1ROf4Zst+rUuYURCSqgk+EK+Mml64xoe4uK18wNpXWeaTceNOP4SlUyZ f4uSaAZoNIKgWkqSEuyDBOLHDqYocbypskAyZttU= From: Kieran Bingham To: LibCamera Devel Date: Wed, 14 Aug 2019 10:58:17 +0100 Message-Id: <20190814095817.13625-4-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190814095817.13625-1-kieran.bingham@ideasonboard.com> References: <20190814095817.13625-1-kieran.bingham@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 3/3] readme: Provide build requirements X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Aug 2019 09:58:23 -0000 Provide an initial list of build dependancies for debian based systems. Other distributions will be added separately. Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart Reviewed-by: Niklas Söderlund --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.rst b/README.rst index 0f64e076a9c0..1d4a84996d06 100644 --- a/README.rst +++ b/README.rst @@ -29,3 +29,24 @@ To build and install: 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 + +for device hotplug enumeration: [optional] + pkg-config libudev-dev + +for qcam: [optional] + qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5 + +for documentation: [optional] + python3-sphinx doxygen