]> git.djapps.eu Git - pkg/ggml/sources/whisper.cpp/commitdiff
README : Update README in stream to clarify where to compile from (Issue #1400)
authorai-at-home <redacted>
Sun, 29 Oct 2023 17:11:13 +0000 (12:11 -0500)
committerGitHub <redacted>
Sun, 29 Oct 2023 17:11:13 +0000 (17:11 +0000)
* Clarify doc about where to compile from

* Update examples/stream/README.md

* Update examples/stream/README.md

* Update README.md

---------

Co-authored-by: AI @ Home <>
Co-authored-by: bobqianic <redacted>
examples/stream/README.md

index b030afb9a2e796cdfd7e978bb16c7edfa99f1016..124e7a6d7791e230e3519202ed0c301618147f8c 100644 (file)
@@ -39,6 +39,20 @@ brew install sdl2
 make stream\r
 ```\r
 \r
+Ensure you are at the root of the repo when running `make stream`.  Not within the `examples/stream` dir\r
+as the libraries needed like `common-sdl.h` are located within `examples`.  Attempting to compile within\r
+`examples/steam` means your compiler cannot find them and it gives an error it cannot find the file.\r
+\r
+```bash\r
+whisper.cpp/examples/stream$ make stream\r
+g++     stream.cpp   -o stream\r
+stream.cpp:6:10: fatal error: common/sdl.h: No such file or directory\r
+    6 | #include "common/sdl.h"\r
+      |          ^~~~~~~~~~~~~~\r
+compilation terminated.\r
+make: *** [<builtin>: stream] Error 1\r
+```\r
+\r
 ## Web version\r
 \r
 This tool can also run in the browser: [examples/stream.wasm](/examples/stream.wasm)\r