@@ -57,22 +57,26 @@ git submodule update --init --recursive
5757
5858** Linux/macOS:**
5959``` bash
60- ./build.sh clean # Clean CMake build artifacts
61- ./build.sh clean-all # Deep clean (C++ + Rust + generated files)
62- ./build.sh debug # Build Debug version
63- ./build.sh release # Build Release version
64- ./build.sh debug-tests # Build Debug with tests
65- ./build.sh release-tests # Build Release with tests
60+ ./build.sh clean # Clean CMake build artifacts
61+ ./build.sh clean-all # Deep clean (C++ + Rust + generated files)
62+ ./build.sh debug # Build Debug version
63+ ./build.sh release # Build Release version
64+ ./build.sh debug-examples # Build Debug with examples
65+ ./build.sh release-examples # Build Release with examples
66+ ./build.sh debug-tests # Build Debug with tests
67+ ./build.sh release-tests # Build Release with tests
6668```
6769** Windows**
6870Using build scripts:
6971``` powershell
70- .\build.cmd clean # Clean CMake build artifacts
71- .\build.cmd clean-all # Deep clean (C++ + Rust + generated files)
72- .\build.cmd debug # Build Debug version
73- .\build.cmd release # Build Release version
74- .\build.cmd debug-tests # Build Debug with tests
75- .\build.cmd release-tests # Build Release with tests
72+ .\build.cmd clean # Clean CMake build artifacts
73+ .\build.cmd clean-all # Deep clean (C++ + Rust + generated files)
74+ .\build.cmd debug # Build Debug version
75+ .\build.cmd release # Build Release version
76+ .\build.cmd debug-examples # Build Debug with examples
77+ .\build.cmd release-examples # Build Release with examples
78+ .\build.cmd debug-tests # Build Debug with tests
79+ .\build.cmd release-tests # Build Release with tests
7680```
7781
7882### Windows build using cmake/vcpkg
@@ -142,6 +146,10 @@ export PATH=$HOME/cmake-3.31/bin:$PATH
142146
143147## 🧪 Run Example
144148
149+ ### Prerequisites
150+
151+ Ensure one of the ` *-examples ` build script options was run prior.
152+
145153### Generate Tokens
146154Before running any participant, create JWT tokens with the proper identity and room name, example
147155``` bash
@@ -151,21 +159,21 @@ lk token create -r test -i your_own_identity --join --valid-for 99999h --dev --
151159### SimpleRoom
152160
153161``` bash
154- ./build/examples /SimpleRoom --url $URL --token < jwt-token>
162+ ./build- < configuration > /bin /SimpleRoom --url $URL --token < jwt-token>
155163```
156164
157165You can also provide the URL and token via environment variables:
158166``` bash
159167export LIVEKIT_URL=ws://localhost:7880
160168export LIVEKIT_TOKEN=< jwt-token>
161- ./build/examples /SimpleRoom
169+ ./build- < configuration > /bin /SimpleRoom
162170```
163171
164172** End-to-End Encryption (E2EE)**
165173You can enable E2E encryption for the streams via --enable_e2ee and --e2ee_key flags,
166174by running the following cmds in two terminals or computers. ** Note, jwt_token needs to be different identity**
167175``` bash
168- ./build/examples /SimpleRoom --url $URL --token < jwt-token> --enable_e2ee --e2ee_key=" your_key"
176+ ./build- < configuration > /bin /SimpleRoom --url $URL --token < jwt-token> --enable_e2ee --e2ee_key=" your_key"
169177```
170178** Note** , ** all participants must use the exact same E2EE configuration and shared key.**
171179If the E2EE keys do not match between participants:
@@ -195,7 +203,7 @@ lk token create -r test -i math-genius --join --valid-for 99999h --dev --room=yo
195203#### ▶ Start Participants
196204Every participant is run as a separate terminal process, note --role needs to match the token identity.
197205``` bash
198- ./build/examples /SimpleRpc --url $URL --token < jwt-token> --role=math-genius
206+ ./build- < configuration > /bin /SimpleRpc --url $URL --token < jwt-token> --role=math-genius
199207```
200208The caller will automatically:
201209- Wait for the greeter and math-genius to join
@@ -223,11 +231,11 @@ lk token create -r test -i greeter --join --valid-for 99999h --dev --room=your_o
223231#### ▶ Start Participants
224232Start the receiver first (so it registers stream handlers before messages arrive):
225233``` bash
226- ./build/examples /SimpleDataStream --url $URL --token < jwt-token>
234+ ./build- < configuration > /bin /SimpleDataStream --url $URL --token < jwt-token>
227235```
228236On another terminal or computer, start the sender
229237``` bash
230- ./build/examples /SimpleDataStream --url $URL --token < jwt-token>
238+ ./build- < configuration > /bin /SimpleDataStream --url $URL --token < jwt-token>
231239```
232240
233241** Sender** (e.g. greeter)
0 commit comments