ai-at-home AI @ Home bobqianic commited on
Commit
51306fa
·
unverified ·
1 Parent(s): 8e7b807

README : Update README in stream to clarify where to compile from (Issue #1400)

Browse files

* 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 <[email protected]>

Files changed (1) hide show
  1. examples/stream/README.md +14 -0
examples/stream/README.md CHANGED
@@ -39,6 +39,20 @@ brew install sdl2
39
  make stream
40
  ```
41
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
42
  ## Web version
43
 
44
  This tool can also run in the browser: [examples/stream.wasm](/examples/stream.wasm)
 
39
  make stream
40
  ```
41
 
42
+ Ensure you are at the root of the repo when running `make stream`. Not within the `examples/stream` dir
43
+ as the libraries needed like `common-sdl.h` are located within `examples`. Attempting to compile within
44
+ `examples/steam` means your compiler cannot find them and it gives an error it cannot find the file.
45
+
46
+ ```bash
47
+ whisper.cpp/examples/stream$ make stream
48
+ g++ stream.cpp -o stream
49
+ stream.cpp:6:10: fatal error: common/sdl.h: No such file or directory
50
+ 6 | #include "common/sdl.h"
51
+ | ^~~~~~~~~~~~~~
52
+ compilation terminated.
53
+ make: *** [<builtin>: stream] Error 1
54
+ ```
55
+
56
  ## Web version
57
 
58
  This tool can also run in the browser: [examples/stream.wasm](/examples/stream.wasm)