Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hzcyf committed Oct 7, 2023
1 parent df02eee commit 8194c6f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# OrbbecSDK
# Orbbec SDK

![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.7.5-green)

The Orbbec 3D camera product software development kit,fully supports UVC, realizes driver-free plug-and-play, provides low-level and high-level simple and easy-to-use APIs, and helps developers use it flexibly in different scenarios.

Besides, this SDK is compatible with Orbbec's original OpenNI protocol devices through built-in code, so that developers can completely migrate to OrbbecSDK to support Orbbec's new generation of products and old products with one set of code.
Besides, this SDK is compatible with Orbbec's original OpenNI protocol devices through built-in code, so that developers can completely migrate to Orbbec SDK to support Orbbec's new generation of products and old products with one set of code.

## What is included in the repository

* **library** : OrbbecSDK core library files and C/C++ header files.
* **library** : Orbbec SDK core library files and C/C++ header files.
* **examples** : C/C++ samples project source code.
* **doc** : API reference documentation and sample documentation.
* **driver** : Windows device driver for OpenNI protocol devices (Dabai, Dabai DCW, Dabai DW, Astra mini Pro, Astra Pro Plus, A1 Pro, Gemini E, Gemini E Lite, Gemini). While modules that use the standard UVC protocol do not need to install drivers.
Expand Down Expand Up @@ -67,7 +67,7 @@ git clone https://github.com/orbbec/OrbbecSDK.git

### 4.3 Use OrbbecSDK in your CMake project

Put the OrbbecSDK directory in the subdirectory of your project, and load the OrbbecSDK in your CMakeLists.txt file like this:
Put the Orbbec SDK directory in the subdirectory of your project, and load the Orbbec SDK in your CMakeLists.txt file like this:

```cmake
cmake_minimum_required(VERSION 3.1.15)
Expand Down Expand Up @@ -99,16 +99,22 @@ cd OrbbecSDK/build/bin # build output dir
./OBMultiStream # OBMultiStream.exe on Windows
```

## Download OrbbecViewer
[Release v1.7.5](https://github.com/orbbec/OrbbecSDK/releases/tag/v1.7.5)
## OrbbecViewer

OrbbecViewer is a simple application base Orbbec SDK,that can be used to view the data stream from the Orbbec camera and control the camera.
![OrbbecViewer](doc/resources/OrbbecViewer.png)

**Supported platforms**: Windows x64, Linux x64&ARM64
**Download link**: [Release v1.7.5](https://github.com/orbbec/OrbbecSDK/releases/tag/v1.7.5)

## Documents

* Github Pages:[https://orbbec.github.io/OrbbecSDK/](https://orbbec.github.io/OrbbecSDK/)
* API Reference: [doc/api/English/index.html](doc/api/English/index.html)
* Tutorial: placed in the [doc/tutorial](doc/tutorial) directory.
* examples: [examples/README.md](examples/README.md)

## Related links

* [Orbbec 3D Club](https://3dclub.orbbec3d.com)
* [Download OrbbecSDK](https://www.orbbec.com/developers/orbbec-sdk/)
* [Orbbec Main Page](https://www.orbbec.com/)
* [Orbbec 3D Club](https://3dclub.orbbec3d.com)
4 changes: 2 additions & 2 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ Windows 10, Ubuntu 16.04/18.04/20.04, ARM Linux 32/64 bit (Raspberry Pi 4B, Jets

## 相关链接

* [3D 视觉开发者社区](https://developer.orbbec.com.cn/)
* [OrbbecSDK 主页](https://developer.orbbec.com.cn/develop_details.html?id=1)
* [奥比中光主页](https://www.orbbec.com.cn/)
* [3D 视觉开发者社区](https://developer.orbbec.com.cn/)
Binary file added doc/resources/OrbbecViewer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8194c6f

Please sign in to comment.