From 65d5eb645c0a8643e9922e6a8e418f6f742fc557 Mon Sep 17 00:00:00 2001 From: Aymeric Dujardin Date: Thu, 1 Jun 2017 18:23:28 +0200 Subject: [PATCH] Update README --- README.md | 30 +++++++++---------- {others => other}/multi camera/CMakeLists.txt | 0 {others => other}/multi camera/README.md | 0 {others => other}/multi camera/src/main.cpp | 0 .../opengl gpu interop/CMakeLists.txt | 0 .../opengl gpu interop/README.md | 0 .../opengl gpu interop/src/main.cpp | 0 {others => other}/save depth/CMakeLists.txt | 0 {others => other}/save depth/README.md | 0 {others => other}/save depth/src/main.cpp | 0 10 files changed, 14 insertions(+), 16 deletions(-) rename {others => other}/multi camera/CMakeLists.txt (100%) rename {others => other}/multi camera/README.md (100%) rename {others => other}/multi camera/src/main.cpp (100%) rename {others => other}/opengl gpu interop/CMakeLists.txt (100%) rename {others => other}/opengl gpu interop/README.md (100%) rename {others => other}/opengl gpu interop/src/main.cpp (100%) rename {others => other}/save depth/CMakeLists.txt (100%) rename {others => other}/save depth/README.md (100%) rename {others => other}/save depth/src/main.cpp (100%) diff --git a/README.md b/README.md index 3acead99..523d8665 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,32 @@ -# Stereolabs ZED - Example projects +# Stereolabs ZED - Examples Links ---------------- -ZED SDK Download - https://www.stereolabs.com/developers/downloads/ +-------- +ZED SDK - https://www.stereolabs.com/developers/downloads/ -General documentation - https://www.stereolabs.com/documentation/ +General Documentation - https://www.stereolabs.com/documentation/ -ZED SDK API Documentation - https://www.stereolabs.com/developers/documentation/API +API Documentation - https://www.stereolabs.com/developers/documentation/API Contents -------- -This contains the ZED SDK examples to demonstrate how to use each module. +The ZED SDK includes tutorials and samples that demonstrate the API features and code. -* **Tutorials** - A series of simple projects to get started on each module. +* **Tutorials** - A series of basic tutorials that demonstrate the use of each API module. -* **Others** - A series of projects containing useful features. +* **Camera Control** - This sample shows how to adjust the ZED camera parameters. -* **Camera Control** - This sample shows how to tweak the ZED Camera parameters. +* **Depth Sensing** - This sample shows how to capture a 3D point cloud and display with OpenGL. It also shows how to save depth data in different formats. -* **Depth Sensing** - This sample demonstrates how to grab the current point cloud with the ZED SDK and how to display it in a 3D view with OpenGL / freeGLUT. It also allows you to save depth information (depth map image and point cloud) in different formats. +* **Positional Tracking** - This sample shows how to use positional tracking and display the result with OpenGL. -* **Positional Tracking** - This sample demonstrates a simple way to use the ZED as a positional tracker and show the result in a OpenGL window. +* **Spatial Mapping** - This sample shows how to capture a mesh with the ZED and display it with OpenGL -* **Spatial Mapping** - This sample demonstrates how to get a mesh with the ZED. This sample demonstrates how to use the asynchronous function of the ZED mapping API for live preview, and the synchronous function to extract, filter and save a mesh in a obj file. +* **SVO Recording** - This sample shows how to record and playback video files in SVO format. SVO files lets you use all the ZED SDK features without having a ZED connected. -* **SVO Recording** - This sample demonstrates how to use the recording capabilities of the SDK. The SVO file is used to simulate a ZED. This sample allows the recording of such a file and also the decoding. The decoding provides a way to convert the file into a standard video file or into a sequence of images. +* **Other** - Other general samples that demonstrate the use of the ZED SDK. Support ------- -If you need assistance with the ZED SDK please contact the support at support@stereolabs.com - -You can also visit the Help Center at https://support.stereolabs.com +If you need assistance with the ZED, visit our Help Center at https://support.stereolabs.com or contact us at support@stereolabs.com. diff --git a/others/multi camera/CMakeLists.txt b/other/multi camera/CMakeLists.txt similarity index 100% rename from others/multi camera/CMakeLists.txt rename to other/multi camera/CMakeLists.txt diff --git a/others/multi camera/README.md b/other/multi camera/README.md similarity index 100% rename from others/multi camera/README.md rename to other/multi camera/README.md diff --git a/others/multi camera/src/main.cpp b/other/multi camera/src/main.cpp similarity index 100% rename from others/multi camera/src/main.cpp rename to other/multi camera/src/main.cpp diff --git a/others/opengl gpu interop/CMakeLists.txt b/other/opengl gpu interop/CMakeLists.txt similarity index 100% rename from others/opengl gpu interop/CMakeLists.txt rename to other/opengl gpu interop/CMakeLists.txt diff --git a/others/opengl gpu interop/README.md b/other/opengl gpu interop/README.md similarity index 100% rename from others/opengl gpu interop/README.md rename to other/opengl gpu interop/README.md diff --git a/others/opengl gpu interop/src/main.cpp b/other/opengl gpu interop/src/main.cpp similarity index 100% rename from others/opengl gpu interop/src/main.cpp rename to other/opengl gpu interop/src/main.cpp diff --git a/others/save depth/CMakeLists.txt b/other/save depth/CMakeLists.txt similarity index 100% rename from others/save depth/CMakeLists.txt rename to other/save depth/CMakeLists.txt diff --git a/others/save depth/README.md b/other/save depth/README.md similarity index 100% rename from others/save depth/README.md rename to other/save depth/README.md diff --git a/others/save depth/src/main.cpp b/other/save depth/src/main.cpp similarity index 100% rename from others/save depth/src/main.cpp rename to other/save depth/src/main.cpp