Merge pull request #1831 from shimat/nuget_readme

Add README to NuGet packages

Author: shimat

.github/copilot-instructions.md

@@ -18,3 +18,23 @@ $enc = New-Object System.Text.UTF8Encoding $true
 $content = [System.IO.File]::ReadAllText("path\to\file", [System.Text.Encoding]::UTF8)
 [System.IO.File]::WriteAllText("path\to\file", $content, $enc)
 ```
+
+## NuGet README sync
+
+When editing the root `README.md`, also update the NuGet-specific README files accordingly.
+
+| File | Target packages |
+|---|---|
+| `nuget/README.managed.md` | `OpenCvSharp4`, `OpenCvSharp4.Windows`, `OpenCvSharp4.Windows.Slim`, `OpenCvSharp4.Extensions`, `OpenCvSharp4.WpfExtensions` |
+| `nuget/README.runtime.md` | `OpenCvSharp4.runtime.*`, `OpenCvSharp4.official.runtime.*` (all native runtime packages) |
+
+The NuGet READMEs are a subset of the top-level README and consist of the following sections:
+
+- Overview and supported platforms
+- Installation instructions (Quick Start)
+- Requirements
+- Slim profile module coverage table (`README.managed.md` only)
+- Code usage examples (`README.managed.md` only)
+- Links (GitHub, Samples, API Docs, Issue Tracker)
+
+Do **not** include CI badges, Docker instructions, build instructions, or donation links in the NuGet READMEs.

README.md

@@ -215,14 +215,14 @@ If you want to use OpenCV features that are not included by default in OpenCvSha
 - Build OpenCV with opencv_contrib: https://docs.opencv.org/4.x/d7/d9f/tutorial_linux_install.html
 - Install .NET Core SDK: https://learn.microsoft.com/ja-jp/dotnet/core/install/linux-ubuntu
 - Get OpenCvSharp source files
-```
+```bash
 git clone https://github.com/shimat/opencvsharp.git
 cd opencvsharp
 git fetch --all --tags --prune && git checkout ${OPENCVSHARP_VERSION}
 ```
 
 - Build native wrapper `OpenCvSharpExtern`
-```
+```bash
 cd opencvsharp/src
 mkdir build
 cd build
@@ -231,17 +231,14 @@ make -j
 make install
 ```
 You should add a reference to `opencvsharp/src/build/OpenCvSharpExtern/libOpenCvSharpExtern.so`
-```
+```bash
 export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:/home/shimat/opencvsharp/src/build/OpenCvSharpExtern"
 ```
 
-- Add `OpenCvSharp4` NuGet package to your project
-```
-dotnet new console -n ConsoleApp01
-cd ConsoleApp01
-dotnet add package OpenCvSharp4
-# -- edit Program.cs --- # 
-dotnet run
+- Build the managed OpenCvSharp library
+```bash
+cd opencvsharp
+dotnet build src/OpenCvSharp/OpenCvSharp.csproj
 ```
 ## Customizing OpenCV and OpenCvSharp for embedded (ARM) Platforms
 

nuget/OpenCvSharp4.Windows.Slim.csproj

@@ -17,6 +17,7 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.managed.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -33,5 +34,6 @@
 
   <ItemGroup>
     <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.managed.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>

nuget/OpenCvSharp4.Windows.csproj

@@ -18,6 +18,7 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.managed.md</PackageReadmeFile>
   </PropertyGroup>
 
   <!-- This is a meta-package that depends on other packages -->
@@ -36,5 +37,6 @@
 
   <ItemGroup>
     <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.managed.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>

nuget/OpenCvSharp4.official.runtime.linux-x64.csproj

@@ -18,10 +18,12 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.runtime.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="libOpenCvSharpExtern.so" Pack="true" PackagePath="runtimes/linux-x64/native/" />
     <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.runtime.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>

nuget/OpenCvSharp4.official.runtime.linux-x64.slim.csproj

@@ -17,10 +17,12 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.runtime.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="libOpenCvSharpExtern.so" Pack="true" PackagePath="runtimes/linux-x64/native/" />
     <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.runtime.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>

nuget/OpenCvSharp4.official.runtime.ubuntu.22.04-x64.csproj

@@ -18,10 +18,12 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.runtime.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="libOpenCvSharpExtern.so" Pack="true" PackagePath="runtimes/ubuntu.22.04-x64/native/" />
-    <None Include="icon\opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.runtime.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>

nuget/OpenCvSharp4.official.runtime.ubuntu.22.04-x64.slim.csproj

@@ -17,10 +17,12 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.runtime.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="libOpenCvSharpExtern.so" Pack="true" PackagePath="runtimes/ubuntu.22.04-x64/native/" />
-    <None Include="icon\opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.runtime.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>

nuget/OpenCvSharp4.official.runtime.ubuntu.24.04-x64.csproj

@@ -18,10 +18,12 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.runtime.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="libOpenCvSharpExtern.so" Pack="true" PackagePath="runtimes/ubuntu.24.04-x64/native/" />
-    <None Include="icon\opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.runtime.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>

nuget/OpenCvSharp4.official.runtime.ubuntu.24.04-x64.slim.csproj

@@ -17,10 +17,12 @@
     <RepositoryUrl>https://github.com/shimat/opencvsharp.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.runtime.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="libOpenCvSharpExtern.so" Pack="true" PackagePath="runtimes/ubuntu.24.04-x64/native/" />
-    <None Include="icon\opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="icon/opencvsharp.png" Pack="true" PackagePath="" />
+    <None Include="README.runtime.md" Pack="true" PackagePath="" />
   </ItemGroup>
 </Project>