Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix example link in readme #290

Merged
merged 1 commit into from
Nov 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@

If you want to add new opencv API/Module,

1. take a look at https://github.com/rainyl/opencv_dart?tab=readme-ov-file#for-developers to build this project from source
1. build [libdartcv](https://github.com/rainyl/dartcv/blob/main/README.md) from source
2. add new C wrappers in `src` and make sure it is correctly build
3. add your `.h` file to ffigen.yaml and run `dart run ffigen --config ffigen.yaml`
4. add corresponding dart code in `lib`
3. add your `.h` file to ffigen in [dartcv4](https://github.com/rainyl/opencv_dart/tree/main/packages/dartcv) and run `dart run ffigen --config ffigen.yaml`
4. add corresponding dart code in [lib](https://github.com/rainyl/opencv_dart/tree/main/packages/dartcv/lib)
5. write testing code and test whether it works as expected

Note: C wrappers should be added to [dartcv](https://github.com/rainyl/dartcv) and dart bindings should be added to [dartcv4](https://github.com/rainyl/opencv_dart/tree/main/packages/dartcv)

## Contribute to Documentation

1. `git clone https://github.com/rainyl/opencv_dart`
Expand All @@ -28,8 +30,8 @@ If you want to add new opencv API/Module,
For Windows:

1. `git clone https://github.com/rainyl/opencv_dart`
2. cd `opencv_dart`
3. dart run opencv_dart:setup windows -a x64
2. cd `opencv_dart/packages/dartcv`
3. install dependencies and add dynamic library path to PATH environment variable.
4. now write new dart tests and place them in `test/` directory.
5. run `dart test`
6. (Optional) add the **absolute** path of opencv_dart/windows to PATH environment variable, which can ebable the testing sidebar of VSCode.
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,7 @@ void main() {

### 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
see [awesome-opencv_dart](https://github.com/rainyl/awesome-opencv_dart) and share yours

## TODO

Expand Down
2 changes: 1 addition & 1 deletion packages/opencv_core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ OpenCV for Flutter, if `highgui` or `videoio` is required, use [opencv_dart](htt

## Examples

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

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

Expand Down
2 changes: 1 addition & 1 deletion packages/opencv_dart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ use [opencv_core](https://pub.dev/packages/opencv_core)

## Examples

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

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

Expand Down
Loading