From e48e5c6fe0a31e7425e08edb70970bc3eae63e32 Mon Sep 17 00:00:00 2001
From: Matevz Morato <matevz.morato@gmail.com>
Date: Fri, 21 Jun 2024 21:46:51 +0200
Subject: [PATCH] Update README.md

---
 README.md          | 37 +++++++++++++++----------------------
 examples/README.md | 17 +++++++++++++++++
 2 files changed, 32 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 812507e23..fb8f26bb2 100644
--- a/README.md
+++ b/README.md
@@ -4,19 +4,24 @@
 [![Docs](https://img.shields.io/badge/Docs-DepthAI_API-yellow)](https://docs.luxonis.com/projects/api)
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 
-Core C++ library
+Core depthai library for interfacing with Luxonis DepthAI hardware.
+
+> ⚠️ This is a `v3_develop` branch of library which is still in active development without a stable API yet.
 
-## Documentation
 
+## Documentation
 Documentation is available over at [Luxonis DepthAI API](https://docs.luxonis.com/projects/api/en/latest/)
 
 ## Disclaimer
-DepthAI library doesn't yet provide API stability guarantees. While we take care to properly deprecate old functions, some changes might still be breaking. We expect to provide API stability from version 3.0.0 onwards.
+DepthAI library doesn't yet provide API stability guarantees. While we take care to properly deprecate old functions, some changes might still be breaking.
+
+## Examples
+Examples for both C++ and Python are available in the `examples` folder. To get started with them see [README.md](./examples/README.md) for more information.
 
 ## Dependencies
 - CMake >= 3.14
-- C/C++14 compiler
-- [optional] OpenCV 4 (required if building examples)
+- C/C++17 compiler
+- [optional] OpenCV 4 (required if building examples and for record and replay)
 - [optional] PCL (required for point cloud example)
 
 To install OpenCV:
@@ -27,6 +32,9 @@ To install PCL:
 MacOS: `brew install pcl`
 Linux: `sudo apt install libpcl-dev`
 
+## Python specific information
+For more specific information about Python bindings, see [Python README](./bindings/python/README.md).
+
 ## Building
 
 Make sure submodules are updated
@@ -76,23 +84,6 @@ cmake -S. -Bbuild -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmak
 cmake --build build
 ```
 
-
-## Running examples
-
-To build the examples configure with following option added
-```
-cmake -S. -Bbuild -D'DEPTHAI_BUILD_EXAMPLES=ON'
-cmake --build build
-```
-
-Then navigate to `build/examples` folder and run a preferred example
-```
-cd build/examples
-./MobileNet/rgb_mobilenet
-```
-
-> ℹ️ Multi-Config generators (like Visual Studio on Windows) will have the examples built in `build/examples/MobileNet/[Debug/Release/...]/rgb_mobilenet`
-
 ## Integration
 
 Under releases you may find prebuilt library for Windows, for use in either integration method. See [Releases](https://github.com/luxonis/depthai-core/releases)
@@ -196,6 +187,8 @@ The following environment variables can be set to alter default behavior of the
 | DEPTHAI_CRASHDUMP | Directory in which to save the crash dump. |
 | DEPTHAI_CRASHDUMP_TIMEOUT | Specifies the duration in seconds to wait for device reboot when obtaining a crash dump. Crash dump retrieval disabled if 0. |
 | DEPTHAI_DISABLE_FEEDBACK | Disables crash dump and pipeline schema collection used to improve the library |
+
+
 ## Running tests
 
 To run the tests build the library with the following options
diff --git a/examples/README.md b/examples/README.md
index 7f912ee3a..c98b7e730 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -129,3 +129,20 @@ with dai.Pipeline() as pipeline:
         if cv2.waitKey(1) == ord('q'):
             break
 ```
+
+
+## Running examples
+
+To build the examples configure with following option added from the root of the repository:
+```
+cmake -S. -Bbuild -D'DEPTHAI_BUILD_EXAMPLES=ON'
+cmake --build build
+```
+
+Then navigate to `build/examples` folder and run a preferred example
+```
+cd build/examples
+./MobileNet/rgb_mobilenet
+```
+
+> ℹ️ Multi-Config generators (like Visual Studio on Windows) will have the examples built in `build/examples/MobileNet/[Debug/Release/...]/rgb_mobilenet`
\ No newline at end of file