Skip to content

Commit b6d564b

Browse files
README adjustments from review (#86)
* Fix LiveKit docs link * Update examples paths/readme
1 parent 6c766ab commit b6d564b

1 file changed

Lines changed: 22 additions & 14 deletions

File tree

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Use this SDK to add realtime video, audio and data features to your C++ app. By
2020
- **Git LFS** (required for examples)
2121
Some example data files (e.g., audio assets) are stored using Git LFS.
2222
You must install Git LFS before cloning or pulling the repo if you want to run the examples.
23-
- **livekit-cli** install livekit-cli by following the (official livekit docs)[https://docs.livekit.io/intro/basics/cli/start/]
24-
- **livekit-server** install livekit-server by following the (official livekit docs)[https://docs.livekit.io/transport/self-hosting/local/]
23+
- **livekit-cli** install livekit-cli by following the [official LiveKit docs](https://docs.livekit.io/intro/basics/cli/start/)
24+
- **livekit-server** install livekit-server by following the [official LiveKit docs](https://docs.livekit.io/transport/self-hosting/local/)
2525

2626
**Platform-Specific Requirements:**
2727

@@ -60,22 +60,26 @@ git lfs pull
6060

6161
**Linux/macOS:**
6262
```bash
63-
./build.sh clean # Clean CMake build artifacts
64-
./build.sh clean-all # Deep clean (C++ + Rust + generated files)
65-
./build.sh debug # Build Debug version
66-
./build.sh release # Build Release version
67-
./build.sh debug-tests # Build Debug with tests
68-
./build.sh release-tests # Build Release with tests
63+
./build.sh clean # Clean CMake build artifacts
64+
./build.sh clean-all # Deep clean (C++ + Rust + generated files)
65+
./build.sh debug # Build Debug version
66+
./build.sh release # Build Release version
67+
./build.sh debug-examples # Build Debug with examples
68+
./build.sh release-examples # Build Release with examples
69+
./build.sh debug-tests # Build Debug with tests
70+
./build.sh release-tests # Build Release with tests
6971
```
7072
**Windows**
7173
Using build scripts:
7274
```powershell
73-
.\build.cmd clean # Clean CMake build artifacts
74-
.\build.cmd clean-all # Deep clean (C++ + Rust + generated files)
75-
.\build.cmd debug # Build Debug version
76-
.\build.cmd release # Build Release version
77-
.\build.cmd debug-tests # Build Debug with tests
78-
.\build.cmd release-tests # Build Release with tests
75+
.\build.cmd clean # Clean CMake build artifacts
76+
.\build.cmd clean-all # Deep clean (C++ + Rust + generated files)
77+
.\build.cmd debug # Build Debug version
78+
.\build.cmd release # Build Release version
79+
.\build.cmd debug-examples # Build Debug with examples
80+
.\build.cmd release-examples # Build Release with examples
81+
.\build.cmd debug-tests # Build Debug with tests
82+
.\build.cmd release-tests # Build Release with tests
7983
```
8084

8185
### Windows build using cmake/vcpkg
@@ -145,6 +149,10 @@ export PATH=$HOME/cmake-3.31/bin:$PATH
145149

146150
## 🧪 Run Example
147151

152+
### Prerequisites
153+
154+
Ensure one of the `*-examples` build script options was run prior.
155+
148156
### Generate Tokens
149157
Before running any participant, create JWT tokens with the proper identity and room name, example
150158
```bash

0 commit comments

Comments
 (0)