Merge pull request #271 from rainyl/docs

update readme
rainyl · Oct 25, 2024 · f237b0a · f237b0a
2 parents 3f5f8c0 + 269f8ee
commit f237b0a
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,7 @@ OpenCV Bindings for Dart Language. Support both asynchronous and synchronous!
     - [Usage](#usage)
       - [Pure Dart](#pure-dart)
       - [Flutter](#flutter)
+    - [Screenshots](#screenshots)
     - [TODO](#todo)
   - [Contributors](#contributors)
   - [Acknowledgement](#acknowledgement)
@@ -112,6 +113,13 @@ see [example](https://github.com/rainyl/opencv_dart/tree/main/example)
 
 ~~More examples are on the way...~~ see [awesome-opencv_dart](https://github.com/rainyl/awesome-opencv_dart) and share yours
 
+### Screenshots
+
+| | |
+|:-------------------------:|:-------------------------:|
+|<img width="480" alt="example" src="https://raw.githubusercontent.com/rainyl/opencv_dart/main/images/example.png"> |  <img width="480" alt="dnn_minist" src="https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/refs/heads/main/examples/dnn_mnist/images/screenshot.png">|
+|<img width="480" alt="videoio texture renderer" src="https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/30fa0f501cea4a8a77d7c2f0e30c2b0c64b7dbec/examples/texture_renderer/texture_rgba_renderer.gif">|<img width="480" alt="videoio texture renderer" src="https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/refs/heads/main/examples/stitching/stitching_demo.png">|
+
 ### TODO
 
 - [x] ~~compile libs for android, linux~~

diff --git a/images/example.png b/images/example.png
diff --git a/packages/dartcv/README.md b/packages/dartcv/README.md
@@ -47,10 +47,22 @@ void main() async {
 }
 ```
 
+### Q&A
+
+- Refer to [#212](https://github.com/rainyl/opencv_dart/issues/212) or open new issues.
+
 ### More examples
 
 Refer to [tests](https://github.com/rainyl/opencv_dart/tree/main/packages/dartcv/test)
 
+## Screenshots
+
+see [Screenshots](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Screenshots)
+
 ## Build libdartcv from source
 
 Refer to [dartcv](https://github.com/rainyl/dartcv/blob/main/README.md)
+
+## License
+
+[Apache-2.0 License](LICENSE)
diff --git a/packages/opencv_core/README.md b/packages/opencv_core/README.md
@@ -5,7 +5,7 @@ OpenCV for Flutter, if `highgui` or `videoio` is required, use [opencv_dart](htt
 > [!IMPORTANT]
 >
 > OpenCV SDK (~100M) will be downloaded via `FetchContent` of cmake, you can
-> set `DARTCV_CACHE_PATH` environment variable to cache it and avoid downloading it again.
+> set `DARTCV_CACHE_DIR` environment variable to cache it and avoid downloading it again.
 
 ## Supported platforms
 
@@ -25,12 +25,12 @@ OpenCV for Flutter, if `highgui` or `videoio` is required, use [opencv_dart](htt
 
 see [example](https://github.com/rainyl/opencv_dart/tree/main/example)
 
-![example](https://raw.githubusercontent.com/rainyl/opencv_dart/main/images/example.png)
-
 More examples refet to [awesome-opencv_dart](https://github.com/rainyl/awesome-opencv_dart) and share yours
 
-![DNN MNIST](https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/refs/heads/main/examples/dnn_mnist/images/screenshot.png)
+## Screenshots
+
+see [Screenshots](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Screenshots)
 
 ## License
 
-Apache-2.0 License
+[Apache-2.0 License](LICENSE)
diff --git a/packages/opencv_core/example/windows/runner/main.cpp b/packages/opencv_core/example/windows/runner/main.cpp
@@ -26,7 +26,7 @@ int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
 
   FlutterWindow window(project);
   Win32Window::Point origin(10, 10);
-  Win32Window::Size size(1280, 720);
+  Win32Window::Size size(480, 720);
   if (!window.Create(L"opencv_core_example", origin, size)) {
     return EXIT_FAILURE;
   }

diff --git a/packages/opencv_dart/CHANGELOG.md b/packages/opencv_dart/CHANGELOG.md
@@ -1,6 +1,6 @@
 ## 1.2.6
 
-* breaking change: local build. Will download opencv sdk (~100M) from remote, set `DARTCV_CACHE_PATH` to cache it and avoid downloading in every build.
+* breaking change: local build. Will download opencv sdk (~100M) from remote, set `DARTCV_CACHE_DIR` to cache it and avoid downloading in every build.
 * breaking change: many async class constructors and getters/setters were removed.
 * Breaking change: highgui, remove Window and Trackbar class, use functions like opencv c++ and python directly, e.g., cv.namedWindow("TestWindow"), more examples refer to: https://github.com/rainyl/opencv_dart/blob/split-dartcv/packages/dartcv/test/highgui_test.dart
 * macos: support 10.15 and above

diff --git a/packages/opencv_dart/README.md b/packages/opencv_dart/README.md
@@ -7,7 +7,7 @@ use [opencv_core](https://pub.dev/packages/opencv_core)
 >
 > From `v1.3.0`, dynamic libraries will be built locally, invoked by flutter during the build.
 > Note: OpenCV SDK (~100M) will be downloaded via `FetchContent` of cmake, you can
-> set `DARTCV_CACHE_PATH` environment variable to cache it and avoid downloading it again.
+> set `DARTCV_CACHE_DIR` environment variable to cache it and avoid downloading it again.
 >
 > `v1.0.4 ~ v1.0.6`, libs will be downloaded from
 > [Releases](https://github.com/rainyl/opencv_dart/releases) automatically.
@@ -51,12 +51,12 @@ use [opencv_core](https://pub.dev/packages/opencv_core)
 
 see [example](https://github.com/rainyl/opencv_dart/tree/main/example)
 
-![example](https://raw.githubusercontent.com/rainyl/opencv_dart/main/images/example.png)
-
 More examples refet to [awesome-opencv_dart](https://github.com/rainyl/awesome-opencv_dart) and share yours
 
-![DNN MNIST](https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/refs/heads/main/examples/dnn_mnist/images/screenshot.png)
+## Screenshots
+
+see [Screenshots](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Screenshots)
 
 ## License
 
-Apache-2.0 License
+[Apache-2.0 License](LICENSE)