[libcamera-devel,3/3] readme: Provide build requirements

Message ID 20190814095817.13625-4-kieran.bingham@ideasonboard.com
State Accepted
Headers show
Series
  • README updates
Related show

Commit Message

Kieran Bingham Aug. 14, 2019, 9:58 a.m. UTC
Provide an initial list of build dependancies for debian based systems.
Other distributions will be added separately.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 README.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

Comments

Laurent Pinchart Aug. 14, 2019, 11:27 a.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Wed, Aug 14, 2019 at 10:58:17AM +0100, Kieran Bingham wrote:
> Provide an initial list of build dependancies for debian based systems.

s/debian based/Debian-based/

> Other distributions will be added separately.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> ---
>  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.

s/debian/Debian/
s/ubuntu/Ubuntu/

> +Other distributions may have differing package names:
> +
> +A C++ toolchain: [required]
> +	Either {g++, clang++}

I think the package is named clang, not clang++

> +
> +for libcamera: [required]
> +	meson ninja-build

meson depends on ninja-build, do we need to mention the latter
explicitly ? I don't mind if you think we should.

> +
> +for device hotplug enumeration: [optional]
> +	pkg-config libudev-dev
> +
> +for qcam: [optional]
> +	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
> +
> +for documentation: [optional]
> +	python3-sphinx doxygen

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Kieran Bingham Aug. 14, 2019, 11:48 a.m. UTC | #2
Hi Laurent,

On 14/08/2019 12:27, Laurent Pinchart wrote:
> Hi Kieran,
> 
> Thank you for the patch.
> 
> On Wed, Aug 14, 2019 at 10:58:17AM +0100, Kieran Bingham wrote:
>> Provide an initial list of build dependancies for debian based systems.
> 
> s/debian based/Debian-based/

Ack.

> 
>> Other distributions will be added separately.
>>
>> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
>> ---
>>  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.
> 
> s/debian/Debian/
> s/ubuntu/Ubuntu/
> 
Ack.


>> +Other distributions may have differing package names:
>> +
>> +A C++ toolchain: [required]
>> +	Either {g++, clang++}
> 
> I think the package is named clang, not clang++

Hrm ... How did I get that mixed up ... I remember going through and
installing each of these in a clean ubuntu container...

Ho hum ... good spot

Fixed.


>> +
>> +for libcamera: [required]
>> +	meson ninja-build
> 
> meson depends on ninja-build, do we need to mention the latter
> explicitly ? I don't mind if you think we should.

I like that it shows we depend on both.


>> +
>> +for device hotplug enumeration: [optional]
>> +	pkg-config libudev-dev
>> +
>> +for qcam: [optional]
>> +	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
>> +
>> +for documentation: [optional]
>> +	python3-sphinx doxygen
> 
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
>
Niklas Söderlund Aug. 17, 2019, 1:58 p.m. UTC | #3
Hi Kieran,

Thanks for your patch.

On 2019-08-14 10:58:17 +0100, Kieran Bingham wrote:
> Provide an initial list of build dependancies for debian based systems.
> Other distributions will be added separately.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

With the fixes pointed out by Laurent,

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

> ---
>  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
> -- 
> 2.20.1
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Patch

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