-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Aaron Thompson
authored
Dec 9, 2022
1 parent
b95edc8
commit 4b85c3d
Showing
1 changed file
with
7 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,19 +2,15 @@ | |
|
|
||
| ## Introduction | ||
|
|
||
| This SDK enables real-time 3D scanning, asset storage, and analysis in your own iOS app using algorithms and servers from [Standard Cyborg](https://standardcyborg.com). | ||
|
|
||
| The quickest way to get started is to clone this repository, then follow the [iOS Quickstart Guide](https://standardcyborg.com/docs/ios-quickstart) | ||
| This SDK enables real-time 3D scanning and analysis in your own iOS app! | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Repository Overview | ||
|
|
||
| - **StandardCyborgFusion**<br> | ||
| A compiled, binary framework that performs real time 3D reconstruction using the TrueDepth camera | ||
| - **StandardCyborgNetworking**<br> | ||
| A Swift framework that connects to the platform.standardcyborg.com API | ||
| A compiled, binary framework that performs real time 3D reconstruction using the TrueDepth camera. Built from https://github.com/StandardCyborg/StandardCyborgSDK | ||
| - **StandardCyborgUI**<br> | ||
| A Swift framework with classes for driving and visualizing scanning using StandardCyborgFusion | ||
| - **StandardCyborgExample**<br> | ||
|
|
@@ -23,13 +19,8 @@ The quickest way to get started is to clone this repository, then follow the [iO | |
| ## Run included demo app | ||
|
|
||
| 1. `cd StandardCyborgExample` | ||
| 2. Drop your API token into `Info.plist` (from your platform.standardcyborg.com account) | ||
| 3. `pod install` | ||
| 4. Run on a device with TrueDepth | ||
|
|
||
| ## Documentation | ||
|
|
||
| All documentation is hosted at https://standardcyborg.com/docs/ios-quickstart/ | ||
| 1. `pod install` | ||
| 1. Run on an iOS device with a TrueDepth sensor | ||
|
|
||
| ## Requirements | ||
|
|
||
|
|
@@ -39,12 +30,8 @@ All documentation is hosted at https://standardcyborg.com/docs/ios-quickstart/ | |
|
|
||
| ## Feedback, Issues, and Help | ||
|
|
||
| Email [email protected] and we will gladly reply in a timely manner. | ||
|
|
||
| You may also find an answer to your question in our [FAQ](https://standardcyborg.com/docs/faq) | ||
|
|
||
| ## License | ||
|
|
||
| The StandardCyborgFusion framework is provided as a compiled, closed-source framework with a proprietary license. | ||
| The remaining projects within this repository are open source with an Apache 2.0 license. | ||
| See the LICENSE file within each subdirectory in this project for specific details. | ||
| This codebase is released under the MIT license | ||
|
|
||
| See LICENSE file | ||