summaryrefslogtreecommitdiffstats
path: root/Examples
diff options
context:
space:
mode:
authorKonstantin <const@const.me>2023-01-16 20:50:27 +0100
committerKonstantin <const@const.me>2023-01-16 20:50:27 +0100
commit8a1b4ec398e25ecc15596f830f757d8419728296 (patch)
tree2c7d1355df52d3e59d397e56b7621f1402032af4 /Examples
parentaaeab774c3c8e30b2925620fc3d2a34e5f53be4c (diff)
Minor, documentation
Diffstat (limited to 'Examples')
-rw-r--r--Examples/MicrophoneCS/Readme.txt1
-rw-r--r--Examples/TranscribeCS/Readme.txt1
-rw-r--r--Examples/WhisperDesktop/Readme.txt3
-rw-r--r--Examples/WhisperDesktop/WhisperDesktop.vcxproj3
-rw-r--r--Examples/WhisperDesktop/WhisperDesktop.vcxproj.filters3
-rw-r--r--Examples/main/Readme.txt3
-rw-r--r--Examples/main/main.vcxproj3
-rw-r--r--Examples/main/main.vcxproj.filters3
8 files changed, 20 insertions, 0 deletions
diff --git a/Examples/MicrophoneCS/Readme.txt b/Examples/MicrophoneCS/Readme.txt
new file mode 100644
index 0000000..a531fc0
--- /dev/null
+++ b/Examples/MicrophoneCS/Readme.txt
@@ -0,0 +1 @@
+This example builds .NET 6 console application which shows how to use audio capture API of the .NET wrapper. \ No newline at end of file
diff --git a/Examples/TranscribeCS/Readme.txt b/Examples/TranscribeCS/Readme.txt
new file mode 100644
index 0000000..caf97c3
--- /dev/null
+++ b/Examples/TranscribeCS/Readme.txt
@@ -0,0 +1 @@
+This example builds .NET 6 console application which shows how to transcribe or translate audio files with the .NET wrapper. \ No newline at end of file
diff --git a/Examples/WhisperDesktop/Readme.txt b/Examples/WhisperDesktop/Readme.txt
new file mode 100644
index 0000000..9900923
--- /dev/null
+++ b/Examples/WhisperDesktop/Readme.txt
@@ -0,0 +1,3 @@
+This example shows how to consume the DLL from a C++ GUI application.
+
+The GUI is implemented with ATL and WTL libraries. \ No newline at end of file
diff --git a/Examples/WhisperDesktop/WhisperDesktop.vcxproj b/Examples/WhisperDesktop/WhisperDesktop.vcxproj
index 4956410..db6d529 100644
--- a/Examples/WhisperDesktop/WhisperDesktop.vcxproj
+++ b/Examples/WhisperDesktop/WhisperDesktop.vcxproj
@@ -145,6 +145,9 @@
<Project>{701df8c8-e4a5-43ec-9c6b-747bbf4d8e71}</Project>
</ProjectReference>
</ItemGroup>
+ <ItemGroup>
+ <Text Include="Readme.txt" />
+ </ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets">
</ImportGroup>
diff --git a/Examples/WhisperDesktop/WhisperDesktop.vcxproj.filters b/Examples/WhisperDesktop/WhisperDesktop.vcxproj.filters
index 7a36c86..09bb5f1 100644
--- a/Examples/WhisperDesktop/WhisperDesktop.vcxproj.filters
+++ b/Examples/WhisperDesktop/WhisperDesktop.vcxproj.filters
@@ -139,4 +139,7 @@
<ItemGroup>
<Manifest Include="WhisperDesktop.manifest" />
</ItemGroup>
+ <ItemGroup>
+ <Text Include="Readme.txt" />
+ </ItemGroup>
</Project> \ No newline at end of file
diff --git a/Examples/main/Readme.txt b/Examples/main/Readme.txt
new file mode 100644
index 0000000..0810326
--- /dev/null
+++ b/Examples/main/Readme.txt
@@ -0,0 +1,3 @@
+This example shows how to consume the DLL from a C++ console application.
+
+The command-line interface matches the corresponding example from whisper.cpp project. \ No newline at end of file
diff --git a/Examples/main/main.vcxproj b/Examples/main/main.vcxproj
index 4945b88..ba1e191 100644
--- a/Examples/main/main.vcxproj
+++ b/Examples/main/main.vcxproj
@@ -87,6 +87,9 @@
<Project>{701df8c8-e4a5-43ec-9c6b-747bbf4d8e71}</Project>
</ProjectReference>
</ItemGroup>
+ <ItemGroup>
+ <Text Include="Readme.txt" />
+ </ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets">
</ImportGroup>
diff --git a/Examples/main/main.vcxproj.filters b/Examples/main/main.vcxproj.filters
index 94cd8a1..2a4739f 100644
--- a/Examples/main/main.vcxproj.filters
+++ b/Examples/main/main.vcxproj.filters
@@ -9,4 +9,7 @@
<ClInclude Include="params.h" />
<ClInclude Include="miscUtils.h" />
</ItemGroup>
+ <ItemGroup>
+ <Text Include="Readme.txt" />
+ </ItemGroup>
</Project> \ No newline at end of file