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>
This commit is contained in:
Kieran Bingham 2019-08-14 10:31:24 +01:00
parent a8b472598e
commit abc63afca4
2 changed files with 14 additions and 9 deletions

View file

@ -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
```

14
README.rst Normal file
View file

@ -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