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