From 722336cac93a11eac5cd5ef266e4e64cd247574a Mon Sep 17 00:00:00 2001 From: Kouji Matsui Date: Sun, 2 Jul 2023 12:41:42 +0900 Subject: [PATCH] Updated readme. --- README.md | 21 +++++++++++++++++++++ README_ja.md | 20 ++++++++++++++++++++ 2 files changed, 41 insertions(+) diff --git a/README.md b/README.md index ab45e11..50c437c 100644 --- a/README.md +++ b/README.md @@ -630,6 +630,27 @@ So, you can implement your own image data processing to achieve the fastest poss Will show up selection dialog automatically when multiple camera devices are found. +---- + +## Build FlashCap + +FlashCap keeps a clean build environment. +Basically, if you have Visual Studio 2022 .NET development environment installed, you can build it as is. +(Please add the WPF and Windows Forms options. These are required to build the sample code) + +1. Clone this repository. +2. Build `FlashCap.sln`. + * Build it with `dotnet build`. + * Or open `FlashCap.sln` with Visual Studio 2022 and build it. + +NOTE: FlashCap itself should build in a Linux environment, +but since the sample code has a Windows-dependent implementation, +we assume Windows as the development environment. + +Pull requests are welcome! Development is on the `develop` branch and merged into the `main` branch at release time. +Therefore, if you make a pull request, please make new your branch from the `develop` branch. + + ---- ## License diff --git a/README_ja.md b/README_ja.md index 1ce62e3..0dd7f6a 100644 --- a/README_ja.md +++ b/README_ja.md @@ -570,6 +570,26 @@ await device.StartAsync(); 複数のカメラデバイスが検出された場合、自動的に選択ダイアログが表示されます。 +---- + +## 自分でビルドする + +FlashCapは、ビルド環境をクリーンに保っています。 +基本的に、Visual Studio 2022の.NET開発環境がインストールされていればビルド出来ると思います。 +(WPF, Windows Formsのオプションは追加してください。これらはサンプルコードのビルドに必要です) + +1. このリポジトリをクローンします。 +2. `FlashCap.sln`をビルドします。 + * `dotnet build` でビルドします。 + * または、`FlashCap.sln`をVisual Studio 2022で開き、ビルドします。 + +注意: FlashCap自体は、.NET SDKを持つLinux環境でもビルドできるはずですが、サンプルコードにWindowsに依存する実装があるため、 +開発環境にWindowsを想定しています。 + +プルリクエストを歓迎します! 開発は`develop`ブランチ上で行って、リリース時に`main`ブランチにマージしています。 +そのため、プルリクエストを作る場合は、`develop`ブランチからあなたのブランチを切って下さい。 + + ---- ## License