[libcamera-devel] [PATCH 1/3] readme: Convert from Markdown to RST

[Kieran Bingham]

Hi Laurent,

On 14/08/2019 11:23, Laurent Pinchart wrote:
> Hi Kieran,
> 
> Thank you for the patch.
> 
> On Wed, Aug 14, 2019 at 10:58:15AM +0100, Kieran Bingham wrote:
>> The Documentation and top-level README both serve to provide information
>> to new developers and users of libcamera.
> 
> "... serves to provide information to both ... " ?

The both applies to the "Documentation" and the "top level README"


>> 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
> 
> s/documenation/documentation/

/me must get to work on the checkstyle.py spell-checker :-)

> 
>> README.md into ReSTructured text format.
> 
> Good idea. Do you use a tool to render .rst content to check patches
> such as this one ?

I've used both our generated sphinx output, and the render produced by
github at

https://github.com/kbingham/libcamera/blob/kbingham/documentation/readme/README.rst

> 
>> Signed-off-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
> 
> Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> 
>> ---
>>  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
> 

-- 
Regards
--
Kieran