Skip to content

Commit

Permalink
Merge pull request #273 from rainyl/docs
Browse files Browse the repository at this point in the history 
Update Readme
  • Loading branch information
@rainyl
rainyl authored Oct 25, 2024
2 parents 2fb40a8 + 2815e17 commit e34b6bb
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 29 deletions.
2 changes: 0 additions & 2 deletions .editorconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

max_line_length = 100

[Makefile]
indent_style = tab # "space"、"tab"

Expand Down
49 changes: 26 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,45 @@

OpenCV Bindings for Dart Language. Support both asynchronous and synchronous!

<p align="center">
<a href="https://codecov.io/github/rainyl/opencv_dart" ><img src="https://codecov.io/github/rainyl/opencv_dart/graph/badge.svg?token=2H0WWT39SN"/></a>
<a href="https://github.com/rainyl/opencv_dart"><img src="https://img.shields.io/github/stars/rainyl/opencv_dart.svg?style=flat&logo=github&label=stars" alt="Star on Github"></a>
<a href="https://pub.dev/packages/opencv_dart"><img src="https://img.shields.io/pub/v/opencv_dart.svg?logo=dart" alt="https://pub.dev/packages/opencv_dart"></a>
<a href="https://pub.dev/packages/opencv_dart"><img src="https://img.shields.io/pub/popularity/opencv_dart?logo=dart" alt="https://pub.dev/packages/opencv_dart"></a>
<a href="https://opensource.org/license/apache-2-0"><img src="https://img.shields.io/github/license/rainyl/opencv_dart" alt="License: Apache-2.0"></a>
<a href="https://github.com/rainyl/opencv_dart/actions/workflows/build_test_native_assets.yaml"><img src="https://github.com/rainyl/opencv_dart/actions/workflows/build_test_native_assets.yaml/badge.svg" alt="Native Assets Build"></a>
<a href="https://discord.gg/rtkC7MWvPJ"><img src="https://img.shields.io/discord/1268767086683885598?logo=discord" alt="Discord Server"></a>
</p>
| | | |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| <a href="https://codecov.io/github/rainyl/opencv_dart" ><img src="https://codecov.io/github/rainyl/opencv_dart/graph/badge.svg?token=2H0WWT39SN"/></a> | <a href="https://github.com/rainyl/opencv_dart"><img src="https://img.shields.io/github/stars/rainyl/opencv_dart.svg?style=flat&logo=github&label=stars" alt="Star on Github"></a> | <a href="https://opensource.org/license/apache-2-0"><img src="https://img.shields.io/github/license/rainyl/opencv_dart" alt="License: Apache-2.0"></a> |
| <a href="https://github.com/rainyl/opencv_dart/actions/workflows/build_test_native_assets.yaml"><img src="https://github.com/rainyl/opencv_dart/actions/workflows/build_test_native_assets.yaml/badge.svg" alt="Native Assets Build"></a> | <a href="https://discord.gg/rtkC7MWvPJ"><img src="https://img.shields.io/discord/1268767086683885598?logo=discord" alt="Discord Server"></a> | [![Examples](https://github.com/rainyl/opencv_dart/actions/workflows/examples.yaml/badge.svg)](https://github.com/rainyl/opencv_dart/actions/workflows/examples.yaml) |

| Package | Link | Description |
| :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------: | :-----------------------------------: |
| <a href="https://pub.dev/packages/dartcv4"><img src="https://img.shields.io/pub/v/dartcv4.svg?logo=dart&label=dartcv4"/></a> | [dartcv4](https://pub.dev/packages/dartcv4) | OpenCV bindings for Dart Language. |
| <a href="https://pub.dev/packages/opencv_core"><img src="https://img.shields.io/pub/v/opencv_core.svg?logo=dart&label=opencv_core" /></a> | [opencv_core](https://pub.dev/packages/opencv_core) | OpenCV for Flutter, without `videoio` |
| <a href="https://pub.dev/packages/opencv_dart"><img src="https://img.shields.io/pub/v/opencv_dart.svg?logo=dart&label=opencv_dart"/></a> | [opencv_dart](https://pub.dev/packages/opencv_dart) | OpenCV for Flutter, with all modules |

> [!NOTE]
> WIP, APIs may change in the future, contributions are welcome!
- [opencv\_dart](#opencv_dart)
- [Screenshots](#screenshots)
- [Demos](#demos)
- [Supported Platforms](#supported-platforms)
- [Status](#status)
- [Core Modules](#core-modules)
- [Contrib Modules](#contrib-modules)
- [Usage](#usage)
- [Pure Dart](#pure-dart)
- [Flutter](#flutter)
- [TODO](#todo)
- [Usage](#usage)
- [Pure Dart](#pure-dart)
- [Flutter](#flutter)
- [TODO](#todo)
- [Contributors](#contributors)
- [Acknowledgement](#acknowledgement)
- [Star History](#star-history)
- [License](#license)

<!-- Created by https://github.com/ekalinin/github-markdown-toc -->

## Screenshots
## Demos

| | |
|:-------------------------:|:-------------------------:|
|<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">|
| Screenshot | Link |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: |
| <img height="256" alt="example" src="https://raw.githubusercontent.com/rainyl/opencv_dart/main/images/example.png"> | [example](packages/opencv_core/example/) |
| <img height="256" alt="" src="https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/main/examples/texture_renderer/texture_rgba_renderer.gif"> | [videoio texture renderer](https://github.com/rainyl/awesome-opencv_dart/tree/main/examples/texture_renderer) |
| <img height="256" alt="dnn_minist" src="https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/refs/heads/main/examples/dnn_mnist/images/screenshot.png"> | [DNN MNIST inference](https://github.com/rainyl/awesome-opencv_dart/tree/main/examples/dnn_mnist) |
| <img height="256" alt="stitching" src="https://raw.githubusercontent.com/rainyl/awesome-opencv_dart/refs/heads/main/examples/stitching/stitching_demo.png"> | [stitching](https://github.com/rainyl/awesome-opencv_dart/tree/main/examples/stitching) |

## Supported Platforms

Expand Down Expand Up @@ -93,9 +96,9 @@ OpenCV Bindings for Dart Language. Support both asynchronous and synchronous!
- modules not in the above table are not considered, contributions are welcome
- ~~videoio: `cv.VideoCapture` from file is not supported yet~~ supported now.

### Usage
## Usage

#### Pure Dart
### Pure Dart

```dart
import 'package:dartcv4/dartcv.dart' as cv;
Expand All @@ -109,13 +112,13 @@ void main() {
}
```

#### Flutter
### Flutter

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

### TODO
## TODO

- [x] ~~compile libs for android, linux~~
- [x] ~~support for iOS, macOS~~
Expand Down
2 changes: 1 addition & 1 deletion packages/dartcv/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Refer to [tests](https://github.com/rainyl/opencv_dart/tree/main/packages/dartcv

## Screenshots

see [Screenshots](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Screenshots)
see [Demos](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Demos)

## Build libdartcv from source

Expand Down
4 changes: 2 additions & 2 deletions packages/opencv_core/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ OpenCV for Flutter, if `highgui` or `videoio` is required, use [opencv_dart](htt

## Examples

see [example](https://github.com/rainyl/opencv_dart/tree/main/example)
see [example](https://github.com/rainyl/opencv_core/tree/main/example)

More examples refet to [awesome-opencv_dart](https://github.com/rainyl/awesome-opencv_dart) and share yours

## Screenshots

see [Screenshots](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Screenshots)
see [Demos](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Demos)

## License

Expand Down
2 changes: 1 addition & 1 deletion packages/opencv_dart/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ More examples refet to [awesome-opencv_dart](https://github.com/rainyl/awesome-o

## Screenshots

see [Screenshots](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Screenshots)
see [Demos](https://github.com/rainyl/opencv_dart?tab=readme-ov-file#Demos)

## License

Expand Down

0 comments on commit e34b6bb

Please sign in to comment.