summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKieran Bingham <kieran.bingham@ideasonboard.com>2019-08-14 10:31:24 +0100
committerKieran Bingham <kieran.bingham@ideasonboard.com>2019-08-16 08:51:28 +0100
commitabc63afca419d3b1bf2b0e109a2b52ebc36abfb5 (patch)
tree62df86eb27984866b10e9956f209f9f01cd8f31b
parenta8b472598ebc7874651a92f6342c714c37b0f083 (diff)
readme: Convert from Markdown to RST
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 documentation (and thus the libcamera.org website) convert the README.md into ReSTructured text format. Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
-rw-r--r--README.md9
-rw-r--r--README.rst14
2 files changed, 14 insertions, 9 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 45ae3a41..00000000
--- 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 00000000..9a8261ac
--- /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