diff --git a/.github/workflows/docfx.yml b/.github/workflows/docfx.yml index 3a404bdc96..f11f5999f2 100644 --- a/.github/workflows/docfx.yml +++ b/.github/workflows/docfx.yml @@ -33,12 +33,12 @@ jobs: - name: Build Documentation shell: pwsh - run: docfx docfx/docfx.json + run: docfx docs/docfx/docfx.json - name: Upload GitHub Pages artifact uses: actions/upload-pages-artifact@v4 with: - path: docfx/_site + path: docs/docfx/_site deploy: needs: build diff --git a/.github/workflows/publish_nuget.yml b/.github/workflows/publish_nuget.yml index 7170c52b5e..e91f14d34c 100644 --- a/.github/workflows/publish_nuget.yml +++ b/.github/workflows/publish_nuget.yml @@ -101,7 +101,7 @@ jobs: - name: Rename run: | for f in $(find $PWD -maxdepth 1 -regex ".+\.s?nupkg"); do - dotnet run --project tool/OpenCvSharp.NupkgBetaRemover --configuration Release -- "$f" + dotnet run --project src/tools/OpenCvSharp.NupkgBetaRemover --configuration Release -- "$f" done - name: Verify no beta versions remain diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml index 9c48f22cc4..c8f3a104b1 100644 --- a/.github/workflows/windows.yml +++ b/.github/workflows/windows.yml @@ -22,7 +22,6 @@ jobs: uses: actions/checkout@v6 with: fetch-depth: 1 - submodules: true - name: Install .NET uses: actions/setup-dotnet@v5 @@ -146,7 +145,7 @@ jobs: - name: Run ReleaseMaker shell: powershell run: | - cd "${env:GITHUB_WORKSPACE}\tool\OpenCvSharp.ReleaseMaker" + cd "${env:GITHUB_WORKSPACE}\src\tools\OpenCvSharp.ReleaseMaker" dotnet run -c Release --runtime win-x64 -- "${env:GITHUB_WORKSPACE}" "${env:GITHUB_WORKSPACE}\artifacts" ${{env.OPENCV_VERSION}} - name: Upload NuGet packages and Release packages diff --git a/.gitignore b/.gitignore index 6f087b3569..2f2c3c11dd 100644 --- a/.gitignore +++ b/.gitignore @@ -124,3 +124,5 @@ UpgradeLog*.XML /test/OpenCvSharp.Tests/*.dll Help /tesseract_files +/opencv_artifacts +/tesseract_artifacts diff --git a/.gitmodules b/.gitmodules index ff83a6b21e..e69de29bb2 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +0,0 @@ -[submodule "samples"] - path = samples - url = https://github.com/shimat/opencvsharp_samples.git diff --git a/OpenCvSharp.sln b/OpenCvSharp.sln index 73ba676abc..92066a74bc 100644 --- a/OpenCvSharp.sln +++ b/OpenCvSharp.sln @@ -20,13 +20,11 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "OpenCvSharpExtern", "src\Op EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenCvSharp.DebuggerVisualizers", "src\OpenCvSharp.DebuggerVisualizers\OpenCvSharp.DebuggerVisualizers.csproj", "{4232CB4A-DFE3-46CA-9503-C5F1798BAED3}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tool", "tool", "{A6E578C0-A34A-4CCF-A808-CBAC81CB48C0}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenCvSharp.NupkgBetaRemover", "tool\OpenCvSharp.NupkgBetaRemover\OpenCvSharp.NupkgBetaRemover.csproj", "{CC19F9A5-01A7-4BDF-B34C-CF56F46A474A}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenCvSharp.NupkgBetaRemover", "src\tools\OpenCvSharp.NupkgBetaRemover\OpenCvSharp.NupkgBetaRemover.csproj", "{CC19F9A5-01A7-4BDF-B34C-CF56F46A474A}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenCvSharp.WpfExtensions", "src\OpenCvSharp.WpfExtensions\OpenCvSharp.WpfExtensions.csproj", "{01FD66CE-F81A-4641-BE30-3CF9DE84D6D5}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenCvSharp.ReleaseMaker", "tool\OpenCvSharp.ReleaseMaker\OpenCvSharp.ReleaseMaker.csproj", "{1C399497-5240-439A-879A-4ACB34C409AE}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenCvSharp.ReleaseMaker", "src\tools\OpenCvSharp.ReleaseMaker\OpenCvSharp.ReleaseMaker.csproj", "{1C399497-5240-439A-879A-4ACB34C409AE}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{47A5316C-49F2-402A-A04C-0A0AAA397F47}" ProjectSection(SolutionItems) = preProject @@ -216,9 +214,9 @@ Global {B4B78BB2-1B7C-4CF2-BC72-43789EEDCE00} = {E048D213-B3B9-453F-9A41-29FDEB0D496B} {8E7279F8-F801-4672-B42F-1ED2C68B16A4} = {E048D213-B3B9-453F-9A41-29FDEB0D496B} {4232CB4A-DFE3-46CA-9503-C5F1798BAED3} = {E048D213-B3B9-453F-9A41-29FDEB0D496B} - {CC19F9A5-01A7-4BDF-B34C-CF56F46A474A} = {A6E578C0-A34A-4CCF-A808-CBAC81CB48C0} + {CC19F9A5-01A7-4BDF-B34C-CF56F46A474A} = {E048D213-B3B9-453F-9A41-29FDEB0D496B} {01FD66CE-F81A-4641-BE30-3CF9DE84D6D5} = {E048D213-B3B9-453F-9A41-29FDEB0D496B} - {1C399497-5240-439A-879A-4ACB34C409AE} = {A6E578C0-A34A-4CCF-A808-CBAC81CB48C0} + {1C399497-5240-439A-879A-4ACB34C409AE} = {E048D213-B3B9-453F-9A41-29FDEB0D496B} {FFD602AA-0A08-40DD-8ACD-7F5A3BA51DEC} = {1F113DD0-E292-47A5-8EFF-3FB5D0869BF3} {36F6A125-3633-441E-9794-97EB91E50F20} = {1F113DD0-E292-47A5-8EFF-3FB5D0869BF3} EndGlobalSection diff --git a/docfx/docfx.json b/docfx/docfx.json index 0aa33d241d..6cca82aaef 100644 --- a/docfx/docfx.json +++ b/docfx/docfx.json @@ -37,7 +37,7 @@ { "files": [ "images/**", - "../web/img/**" + "../docs/img/**" ] } ], diff --git a/docfx/.gitignore b/docs/docfx/.gitignore similarity index 100% rename from docfx/.gitignore rename to docs/docfx/.gitignore diff --git a/docfx/api/.gitignore b/docs/docfx/api/.gitignore similarity index 100% rename from docfx/api/.gitignore rename to docs/docfx/api/.gitignore diff --git a/docfx/api/index.md b/docs/docfx/api/index.md similarity index 100% rename from docfx/api/index.md rename to docs/docfx/api/index.md diff --git a/docfx/articles/intro.md b/docs/docfx/articles/intro.md similarity index 100% rename from docfx/articles/intro.md rename to docs/docfx/articles/intro.md diff --git a/docfx/articles/toc.yml b/docs/docfx/articles/toc.yml similarity index 100% rename from docfx/articles/toc.yml rename to docs/docfx/articles/toc.yml diff --git a/docs/docfx/docfx.json b/docs/docfx/docfx.json new file mode 100644 index 0000000000..32bb8187d4 --- /dev/null +++ b/docs/docfx/docfx.json @@ -0,0 +1,76 @@ +{ + "metadata": [ + { + "src": [ + { + "files": ["OpenCvSharp/OpenCvSharp.csproj"], + "src": "../../src" + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "properties": { + "TargetFramework": "net8" + } + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ] + }, + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md", + "../../*.md" + ] + } + ], + "resource": [ + { + "files": [ + "images/**", + "../img/**" + ] + } + ], + "dest": "_site", + "globalMetadata": { + "_appName": "OpenCvSharp", + "_appTitle": "OpenCvSharp Documentation", + "_appFooter": "OpenCvSharp - .NET wrapper for OpenCV", + "_enableSearch": true, + "_enableNewTab": true, + "_disableContribution": false, + "_gitContribute": { + "repo": "https://github.com/shimat/opencvsharp", + "branch": "main" + }, + "_gitUrlPattern": "github", + "pdf": false + }, + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default", + "modern", + "templates/material" + ], + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false, + "xref": [ + "https://xref.docs.microsoft.com/query?uid={uid}" + ] + } +} \ No newline at end of file diff --git a/docfx/index.md b/docs/docfx/index.md similarity index 100% rename from docfx/index.md rename to docs/docfx/index.md diff --git a/docfx/templates/material/public/main.css b/docs/docfx/templates/material/public/main.css similarity index 100% rename from docfx/templates/material/public/main.css rename to docs/docfx/templates/material/public/main.css diff --git a/docfx/toc.yml b/docs/docfx/toc.yml similarity index 100% rename from docfx/toc.yml rename to docs/docfx/toc.yml diff --git a/docs/embedded-builds.md b/docs/embedded-builds.md index efbe08a113..f7c18599aa 100644 --- a/docs/embedded-builds.md +++ b/docs/embedded-builds.md @@ -49,8 +49,8 @@ Two build scripts are provided for convenience: | Script | Description | Output Size | |--------|-------------|-------------| -| [build-opencvsharp-arm64.sh](tool/build-opencvsharp-arm64.sh) | Full build with all features and contrib modules | ~140MB | -| [build-opencvsharp-minimal-arm64.sh](tool/build-opencvsharp-minimal-arm64.sh) | Minimal build for basic camera capture | ~25MB | +| [build-opencvsharp-arm64.sh](../src/tools/build-opencvsharp-arm64.sh) | Full build with all features and contrib modules | ~140MB | +| [build-opencvsharp-minimal-arm64.sh](../src/tools/build-opencvsharp-minimal-arm64.sh) | Minimal build for basic camera capture | ~25MB | To use either script: ```bash @@ -70,15 +70,15 @@ git checkout 4.10.0 # Run the desired build script cd ~ -chmod +x ~/opencvsharp/tool/build-opencvsharp-minimal-arm64.sh -~/opencvsharp/tool/build-opencvsharp-minimal-arm64.sh +chmod +x ~/opencvsharp/src/tools/build-opencvsharp-minimal-arm64.sh +~/opencvsharp/src/tools/build-opencvsharp-minimal-arm64.sh ``` ## Building a full OpenCV feature set - large (~140MB) output First, you can run with a full-featured set of binaries. It's large, and contains probably things you don't need, but it works. -[A script to do the full-up build for linux-arm64 is available here](tool/build-opencvsharp-arm64.sh), but below are the manual instructions. +[A script to do the full-up build for linux-arm64 is available here](../src/tools/build-opencvsharp-arm64.sh), but below are the manual instructions. ```bash cd ~ @@ -99,7 +99,7 @@ You can build a subset, but it takes some work. The way Linux libraries link, yo This repository attempts to address that by providing better support for minimal, configurable builds. -[A script to do a minimal build for linux-arm64 is available here](tool/build-opencvsharp-minimal-arm64.sh), but below are the manual instructions. +[A script to do a minimal build for linux-arm64 is available here](../src/tools/build-opencvsharp-minimal-arm64.sh), but below are the manual instructions. ### Building OpenCV from Source diff --git a/web/img/cpp_histogram/grayscale_histogram.png b/docs/img/cpp_histogram/grayscale_histogram.png similarity index 100% rename from web/img/cpp_histogram/grayscale_histogram.png rename to docs/img/cpp_histogram/grayscale_histogram.png diff --git a/web/img/cpp_histogram/lenna_grayscale.png b/docs/img/cpp_histogram/lenna_grayscale.png similarity index 100% rename from web/img/cpp_histogram/lenna_grayscale.png rename to docs/img/cpp_histogram/lenna_grayscale.png diff --git a/web/img/debugger-visualizer/cvmat_1.png b/docs/img/debugger-visualizer/cvmat_1.png similarity index 100% rename from web/img/debugger-visualizer/cvmat_1.png rename to docs/img/debugger-visualizer/cvmat_1.png diff --git a/web/img/debugger-visualizer/iplimage_1.png b/docs/img/debugger-visualizer/iplimage_1.png similarity index 100% rename from web/img/debugger-visualizer/iplimage_1.png rename to docs/img/debugger-visualizer/iplimage_1.png diff --git a/web/img/debugger-visualizer/iplimage_2.png b/docs/img/debugger-visualizer/iplimage_2.png similarity index 100% rename from web/img/debugger-visualizer/iplimage_2.png rename to docs/img/debugger-visualizer/iplimage_2.png diff --git a/web/img/how-to-install-via-nuget/lenna_inverse_face.png b/docs/img/how-to-install-via-nuget/lenna_inverse_face.png similarity index 100% rename from web/img/how-to-install-via-nuget/lenna_inverse_face.png rename to docs/img/how-to-install-via-nuget/lenna_inverse_face.png diff --git a/web/img/how-to-install-via-nuget/nuget_package_manager.png b/docs/img/how-to-install-via-nuget/nuget_package_manager.png similarity index 100% rename from web/img/how-to-install-via-nuget/nuget_package_manager.png rename to docs/img/how-to-install-via-nuget/nuget_package_manager.png diff --git a/web/img/how-to-install-via-nuget/nuget_package_manager_old.png b/docs/img/how-to-install-via-nuget/nuget_package_manager_old.png similarity index 100% rename from web/img/how-to-install-via-nuget/nuget_package_manager_old.png rename to docs/img/how-to-install-via-nuget/nuget_package_manager_old.png diff --git a/web/img/tutorial-for-windows/01.jpg b/docs/img/tutorial-for-windows/01.jpg similarity index 100% rename from web/img/tutorial-for-windows/01.jpg rename to docs/img/tutorial-for-windows/01.jpg diff --git a/web/img/tutorial-for-windows/02.jpg b/docs/img/tutorial-for-windows/02.jpg similarity index 100% rename from web/img/tutorial-for-windows/02.jpg rename to docs/img/tutorial-for-windows/02.jpg diff --git a/web/img/tutorial-for-windows/03.jpg b/docs/img/tutorial-for-windows/03.jpg similarity index 100% rename from web/img/tutorial-for-windows/03.jpg rename to docs/img/tutorial-for-windows/03.jpg diff --git a/web/img/tutorial-for-windows/04.png b/docs/img/tutorial-for-windows/04.png similarity index 100% rename from web/img/tutorial-for-windows/04.png rename to docs/img/tutorial-for-windows/04.png diff --git a/web/img/when-error-occurs/DllNotFoundException.png b/docs/img/when-error-occurs/DllNotFoundException.png similarity index 100% rename from web/img/when-error-occurs/DllNotFoundException.png rename to docs/img/when-error-occurs/DllNotFoundException.png diff --git a/web/img/when-error-occurs/TargetPlatform.png b/docs/img/when-error-occurs/TargetPlatform.png similarity index 100% rename from web/img/when-error-occurs/TargetPlatform.png rename to docs/img/when-error-occurs/TargetPlatform.png diff --git a/samples b/samples deleted file mode 160000 index 938f165ea0..0000000000 --- a/samples +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 938f165ea0b954e49f81660ec09755dcc8ed2ba0 diff --git a/tool/OpenCvSharp.NupkgBetaRemover/App.config b/src/tools/OpenCvSharp.NupkgBetaRemover/App.config similarity index 100% rename from tool/OpenCvSharp.NupkgBetaRemover/App.config rename to src/tools/OpenCvSharp.NupkgBetaRemover/App.config diff --git a/tool/OpenCvSharp.NupkgBetaRemover/OpenCvSharp.NupkgBetaRemover.csproj b/src/tools/OpenCvSharp.NupkgBetaRemover/OpenCvSharp.NupkgBetaRemover.csproj similarity index 100% rename from tool/OpenCvSharp.NupkgBetaRemover/OpenCvSharp.NupkgBetaRemover.csproj rename to src/tools/OpenCvSharp.NupkgBetaRemover/OpenCvSharp.NupkgBetaRemover.csproj diff --git a/tool/OpenCvSharp.NupkgBetaRemover/Program.cs b/src/tools/OpenCvSharp.NupkgBetaRemover/Program.cs similarity index 100% rename from tool/OpenCvSharp.NupkgBetaRemover/Program.cs rename to src/tools/OpenCvSharp.NupkgBetaRemover/Program.cs diff --git a/tool/OpenCvSharp.NupkgBetaRemover/Properties/AssemblyInfo.cs b/src/tools/OpenCvSharp.NupkgBetaRemover/Properties/AssemblyInfo.cs similarity index 100% rename from tool/OpenCvSharp.NupkgBetaRemover/Properties/AssemblyInfo.cs rename to src/tools/OpenCvSharp.NupkgBetaRemover/Properties/AssemblyInfo.cs diff --git a/tool/OpenCvSharp.ReleaseMaker/OpenCvSharp.ReleaseMaker.csproj b/src/tools/OpenCvSharp.ReleaseMaker/OpenCvSharp.ReleaseMaker.csproj similarity index 100% rename from tool/OpenCvSharp.ReleaseMaker/OpenCvSharp.ReleaseMaker.csproj rename to src/tools/OpenCvSharp.ReleaseMaker/OpenCvSharp.ReleaseMaker.csproj diff --git a/tool/OpenCvSharp.ReleaseMaker/Packer.cs b/src/tools/OpenCvSharp.ReleaseMaker/Packer.cs similarity index 90% rename from tool/OpenCvSharp.ReleaseMaker/Packer.cs rename to src/tools/OpenCvSharp.ReleaseMaker/Packer.cs index e996c798a1..81555cc72f 100644 --- a/tool/OpenCvSharp.ReleaseMaker/Packer.cs +++ b/src/tools/OpenCvSharp.ReleaseMaker/Packer.cs @@ -96,7 +96,6 @@ private static IReadOnlyList UwpNativeDlls(string version) public static void Pack(string srcDir, string dstDir, string opencvVersion) { MakeBinaryPackage(srcDir, dstDir, opencvVersion); - MakeSamplePackage(srcDir, dstDir, opencvVersion); } /// @@ -197,43 +196,12 @@ private static void MakeBinaryPackage(string dir, string dirDst, string opencvVe } } - /// - /// Create a zip package that contains code samples - /// - /// - /// - /// - private static void MakeSamplePackage(string dirSrc, string dirDst, string version) - { - dirSrc = Path.Combine(dirSrc, "samples"); - dirDst = Path.Combine(dirDst, GetSampleDstDirName(version)); - - CopyDirectory(dirSrc, dirDst); - - var dstFileName = dirDst + ".zip"; - File.Delete(dstFileName); - - ZipFile.CreateFromDirectory( - dirDst, - dstFileName, - CompressionLevel.Optimal, - false); - - Directory.Delete(dirDst, true); - } - private static string GetBinaryDstDirName(string version) { var date = DateTime.Now.ToString("yyyyMMdd"); return $"OpenCvSharp-{version}-{date}"; } - private static string GetSampleDstDirName(string version) - { - var date = DateTime.Now.ToString("yyyyMMdd"); - return $"Sample-{version}-{date}"; - } - /// /// ディレクトリをコピーする。 /// .svn bin obj は除外。 diff --git a/tool/OpenCvSharp.ReleaseMaker/Program.cs b/src/tools/OpenCvSharp.ReleaseMaker/Program.cs similarity index 100% rename from tool/OpenCvSharp.ReleaseMaker/Program.cs rename to src/tools/OpenCvSharp.ReleaseMaker/Program.cs diff --git a/tool/build-opencvsharp-arm64.sh b/src/tools/build-opencvsharp-arm64.sh similarity index 100% rename from tool/build-opencvsharp-arm64.sh rename to src/tools/build-opencvsharp-arm64.sh diff --git a/tool/build-opencvsharp-minimal-arm64.sh b/src/tools/build-opencvsharp-minimal-arm64.sh similarity index 100% rename from tool/build-opencvsharp-minimal-arm64.sh rename to src/tools/build-opencvsharp-minimal-arm64.sh