From b620a664378e964dd79a6a15a698c8953d55f886 Mon Sep 17 00:00:00 2001 From: Florian Echtler Date: Fri, 11 Feb 2022 11:33:42 +0100 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7400b47..be00ced 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,25 @@ This tool records live video of a flat surface with a depth camera, automaticall [![SurfaceStreams Video](assets/anim.gif)](https://www.youtube.com/watch?v=Qe1BROtGyzI "SurfaceStreams Video") -### Building +### Building/Requirements + +Reference platform: Ubuntu 20.04. ``` sudo apt install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libopencv-dev libeigen3-dev -[optional] install libk4a1.4-dev and/or librealsense2-dev +# optional, needs Microsoft Kinect & Intel Realsense repos: +# sudo apt install libk4a1.4-dev librealsense2-dev make && sudo make install ``` + * General (V4L2, SUR40, virtual camera): + * gstreamer-1.16+ (`libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev`) + * opencv-4.2.0 (`libopencv-dev libeigen3-dev`) + * Kinect Azure: + * libk4a-1.4.1 (https://github.com/microsoft/Azure-Kinect-Sensor-SDK) + * Realsense: + * librealsense2-2.50 (https://github.com/IntelRealSense/librealsense) + ### Usage **Example 1** - debug/config view of plain webcam: `./surfacecast v4l2 /dev/video0` @@ -49,18 +60,6 @@ If `config.xml` is present in the working directory at startup, parameters are r * Microsoft Kinect Azure * Virtual Camera -### Build requirements: - -Reference platform: Ubuntu 20.04. - - * General (V4L2, SUR40, virtual camera): - * gstreamer-1.16+ (`libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev`) - * opencv-4.2.0 (`libopencv-dev libeigen3-dev`) - * Kinect Azure: - * libk4a-1.4.1 (https://github.com/microsoft/Azure-Kinect-Sensor-SDK) - * Realsense: - * librealsense2-2.50 (https://github.com/IntelRealSense/librealsense) - ### License SurfaceCast is licensed under the GNU Lesser General Public License v3.0.