From: Georgi Gerganov <redacted>
Date: Tue, 25 Oct 2022 17:25:23 +0000 (+0300)
Subject: Update README.md
X-Git-Tag: upstream/1.7.4~1902
X-Git-Url: https://git.djapps.eu/?a=commitdiff_plain;h=113a4f06d890ddbb861f641cfc99ca7c57287368;p=pkg%2Fggml%2Fsources%2Fwhisper.cpp

Update README.md
---

diff --git a/examples/stream/README.md b/examples/stream/README.md
index e69de29b..8b4c8a6a 100644
--- a/examples/stream/README.md
+++ b/examples/stream/README.md
@@ -0,0 +1,23 @@
+# stream
+
+This is a naive example of performing real-time inference on audio from your microphone.
+The `stream` tool samples the audio every half a second and runs the transcription continously.
+More info is available in [issue #10](https://github.com/ggerganov/whisper.cpp/issues/10).
+
+```java
+./stream -m ./models/ggml-base.en.bin -t 8 --step 500 --length 5000
+```
+
+https://user-images.githubusercontent.com/1991296/194935793-76afede7-cfa8-48d8-a80f-28ba83be7d09.mp4
+
+The `stream` tool depends on SDL2 library to capture audio from the microphone. You can build it like this:
+
+```bash
+# Install SDL2 on Linux
+sudo apt-get install libsdl2-dev
+
+# Install SDL2 on Mac OS
+brew install sdl2
+
+make stream
+```