From dfe4bc6e59292e857366dd3fd079c0a0416c03de Mon Sep 17 00:00:00 2001 From: ai-at-home <149282006+ai-at-home@users.noreply.github.com> Date: Sun, 29 Oct 2023 12:11:13 -0500 Subject: [PATCH] README : Update README in stream to clarify where to compile from (Issue #1400) * 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 <129547291+bobqianic@users.noreply.github.com> --- examples/stream/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/examples/stream/README.md b/examples/stream/README.md index b030afb..124e7a6 100644 --- a/examples/stream/README.md +++ b/examples/stream/README.md @@ -39,6 +39,20 @@ brew install sdl2 make stream ``` +Ensure you are at the root of the repo when running `make stream`. Not within the `examples/stream` dir +as the libraries needed like `common-sdl.h` are located within `examples`. Attempting to compile within +`examples/steam` means your compiler cannot find them and it gives an error it cannot find the file. + +```bash +whisper.cpp/examples/stream$ make stream +g++ stream.cpp -o stream +stream.cpp:6:10: fatal error: common/sdl.h: No such file or directory + 6 | #include "common/sdl.h" + | ^~~~~~~~~~~~~~ +compilation terminated. +make: *** [: stream] Error 1 +``` + ## Web version This tool can also run in the browser: [examples/stream.wasm](/examples/stream.wasm)