Merge branch 'main' into develop

.github/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# The VL.OpenCV contributing guide
+
+## Before getting to work
+* Make sure you understand that code in this repository is under the LGPLv3 and the [implications](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service#6-contributions-under-repository-license) this has
+* Check if anyone else is already working on a similar [issue](https://github.com/vvvv/VL.OpenCV/issues)
+* If not, join the [VL.OpenCV chat](https://matrix.to/#/#VLOpenCV:matrix.org) or start an issue, to lay out your plans and discuss them with others in order to make sure your idea is properly architected and would fit well with the project.
+
+## Working on an issue
+Consider creating a pull-request early but marking it as [DRAFT](https://github.blog/2019-02-14-introducing-draft-pull-requests/) while you're still working on it. This allows for better collaboration and allows you to indicate when you're finished.
+
+For recommended workflows, see [Contributing to an existing library](https://thegraybook.vvvv.org/reference/extending/contributing.html).

.github/pull_request_template.md

@@ -0,0 +1,33 @@
+# PR Details
+
+<!--- A general summary of your changes -->
+
+## Description
+
+<!--- Your changes in detail -->
+
+## Related Issue
+
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Docs change / refactoring / dependency upgrade
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] My change requires a change to the documentation

.github/workflows/main.yml

@@ -16,16 +16,16 @@ jobs:
       uses: actions/checkout@master
 
     - name: Setup MSBuild.exe
-      uses: microsoft/setup-msbuild@v1.0.2
+      uses: microsoft/setup-msbuild@v1.3.1
 
     - name: Setup Nuget.exe
       uses: nuget/setup-nuget@v1
 
     - name: Publish VL Nuget
-      uses: vvvv/[email protected].27-alpha
+      uses: vvvv/[email protected].43
       with:
         csproj: src\VL.OpenCV.csproj
         nuspec: deployment\main.VL.OpenCV.nuspec
         icon-src: https://raw.githubusercontent.com/vvvv/PublicContent/master/nugeticon.png
         icon-dst: ./deployment/nugeticon.png
-        nuget-key: ${{ secrets.NUGET_KEY }}
+        nuget-key: ${{ secrets.VVVV_ORG_NUGET_KEY }}

README.md

@@ -1,59 +1,25 @@
 # VL.OpenCV
-A [VL](https://vvvv.org/documentation/vl) wrapper for [OpenCV](https://opencv.org) based on [OpenCvSharp](https://github.com/shimat/opencvsharp) and also using [SharpDX MediaFoundation](http://sharpdx.org/wiki/class-library-api/mediafoundation/).
+Computer vision library with the following features:
+* Image filters
+* Feature detection and tracking
+* Aruco 3D marker tracking
+* Camera and projector calibration
+* ...
+
+Not GPU accalerated!
 
-Try it with vvvv, the visual live-programming environment for .NET  
-Download: http://visualprogramming.net
+For use with vvvv, the visual live-programming environment for .NET: http://visualprogramming.net
 
-## Using the library
-In order to use this library with vl you have to install the nuget that is available via nuget.org. For information on how to use nugets with vl, see [Manage Nugets](https://thegraybook.vvvv.org/reference/libraries/dependencies.html#manage-nugets) in the vl documentation. As described there you go to the commandline and then type:
+## Getting started
+- Install as [described here](https://thegraybook.vvvv.org/reference/hde/managing-nugets.html) via commandline:
 
-    nuget install VL.OpenCV
+    `nuget install VL.OpenCV`
 
-For pre-release versions use this instead:
+- Usage examples and more information are included in the pack and can be found via the [Help Browser](https://thegraybook.vvvv.org/reference/hde/findinghelp.html)
 
-	nuget install VL.OpenCV -pre
+## Contributing
+- Please see our [Contribution Guide](.github/CONTRIBUTING.md)
+- For custom development requests, please [get in touch](mailto:[email protected])
 
-Once the VL.OpenCV nuget is installed and referenced in your vl document you'll see the category "OpenCV" in the nodebrowser. From there explore the nodes in its main sub-categories:
-
-- Source (VideoIn, ImageReader,...)
-- Sink (Renderer, ImageWriter)
-- Filter (Blur, Dilate, Sobel,...)
-- Detection (Contours, ObjectDetector, MarkerDetector,...)
-
-Demo patches can be found using the Help Browser, or navigating here:
-
-    "\lib\packs\VL.OpenCV...\help\"
-
-And vvvv beta demo patches are somewhat hidden here:
-
-    "\lib\packs\VL.OpenCV...\vvvv\girlpower\"
-
-## Contributing to the development
-If you want to contribute to this repository, clone it into a directory like:
-
-    X:\vl-libs\VL.OpenCV
-
-### Build the C# Project
-Open
-
-    X:\vl-libs\VL.OpenCV\src\VL.OpenCV.sln
-
-in VisualStudio 2019 and build it. This is necessary for a few things that cannot yet be expressed in VL directly, like dynamic enums and static readonly instances of things. 
-
-### Get Nuget Dependency
-This wrapper is depending on two thirdparty nugets: [OpenCvSharp4.runtime.win](https://github.com/shimat/opencvsharp#installation) and [OpenCvSharp4](https://github.com/shimat/opencvsharp#installation). When installing the VL.OpenCV nuget as mentioned under "Using the library" above, this dependency will be installed automatically. To install it otherwise, go to your vvvv's
-
-    \lib\packs 
-
-on a commandline and run
-
-    nuget.exe install OpenCvSharp4.Windows
-
-### Start vvvv
-Then start vvvv with the commandline parameter:
-
-    --package-repositories "X:\vl-libs\"
-
-which will make all packs found in that directory available as dependencies in vl documents. Note that it is possible to have both the nuget (binary) and the sources available. If both are found, the one in the "package-repositories" path is used. Like this you can easily switch between your local development version and the official nuget by simply including your local version in that search path or not.
-
-VL.OpenCV will now show up as Nuget among a documents dependencies as shown [here](https://thegraybook.vvvv.org/reference/libraries/dependencies.html#nugets).
+## Credits
+Based on [OpenCvSharp](https://github.com/shimat/opencvsharp) which in turn in based on [OpenCV](https://opencv.org). Also using [SharpDX MediaFoundation](http://sharpdx.org/wiki/class-library-api/mediafoundation/).

deployment/dev.VL.OpenCV.nuspec

@@ -19,6 +19,7 @@
       <dependency id="OpenCvSharp4.runtime.win" version="4.5.3.20210725" />
       <dependency id="SharpDX.MediaFoundation" version="4.0.1" />
     </dependencies>
+    <readme>docs\README.md</readme>
   </metadata>
   <files>
     <file src="..\lib\net472\VL.OpenCV.dll" target="lib\net472\" exclude="" />
@@ -30,6 +31,7 @@
 	  <file src="..\content\calibrations\*.xml" target="content\calibrations" />
     <file src="..\content\fiducials\*.*" target="content\fiducials" />
     <file src="..\content\assets\*.*" target="content\assets" />
+    <file src="..\README.md" target="docs\" />
     <file src="nugeticon.png" target="icon\" />
   </files>
 </package>

deployment/main.VL.OpenCV.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/10/nuspec.xsd">
   <metadata>
     <id>VL.OpenCV</id>
-    <version>2.5.1</version>
+    <version>2.5.3</version>
     <title>VL.OpenCV</title>
     <authors>Randall Vásquez, vvvv</authors>
     <owners>vvvv</owners>
@@ -20,6 +20,7 @@
       <dependency id="OpenCvSharp4.Extensions" version="4.5.5.20211231" />
       <dependency id="SharpDX.MediaFoundation" version="4.2.0" />
     </dependencies>
+    <readme>docs\README.md</readme>
   </metadata>
   <files>
     <file src="..\lib\net472\VL.OpenCV.dll" target="lib\net472\" exclude="" />
@@ -28,9 +29,10 @@
     <file src="..\vvvv\**" target="vvvv\" exclude="" />
     <file src="..\help\**" target="help\" exclude="" />
     <file src="..\content\haarcascades\*.xml" target="content\haarcascades" />
-	  <file src="..\content\calibrations\*.xml" target="content\calibrations" />
+    <file src="..\content\calibrations\*.xml" target="content\calibrations" />
     <file src="..\content\fiducials\*.*" target="content\fiducials" />
     <file src="..\content\assets\*.*" target="content\assets" />
+    <file src="..\README.md" target="docs\" />
     <file src="nugeticon.png" target="icon\" />
   </files>
 </package>