Skip to content

Commit 3661357

Browse files
added git lfs to README
1 parent 8d5d5ea commit 3661357

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ This SDK enables native C++ applications to connect to LiveKit servers for real-
99
- **Rust / Cargo** (latest stable toolchain)
1010
- **Protobuf** compiler (`protoc`)
1111
- **macOS** users: System frameworks (CoreAudio, AudioToolbox, etc.) are automatically linked via CMake.
12+
- **Git LFS** (required for examples)
13+
Some example data files (e.g., audio assets) are stored using Git LFS.
14+
You must install Git LFS before cloning or pulling the repo if you want to run the examples.
1215

1316

1417
## 🧩 Clone the Repository
@@ -51,7 +54,6 @@ export LIVEKIT_TOKEN=<jwt-token>
5154

5255
Press Ctrl-C to exit the example.
5356

54-
5557
## 🧰 Recommended Setup
5658
### macOS
5759
```bash

examples/simple_room/wav_audio_source.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@
2626
WavData load_wav16(const std::string &path) {
2727
std::ifstream file(path, std::ios::binary);
2828
if (!file) {
29-
throw std::runtime_error("Failed to open WAV file: " + path);
29+
throw std::runtime_error("Failed to open WAV file: " + path +
30+
" (If this file exists in the repo, ensure Git "
31+
"LFS is installed and run `git lfs pull`)");
3032
}
3133

3234
auto read_u32 = [&](uint32_t &out_value) {

0 commit comments

Comments
 (0)