Skip to content

Commit 7de72fb

Browse files
alan-george-lkstephen-derosa
authored andcommitted
docs: slim down README and split build/usage docs into docs/. Targetted .md files.
1 parent b4c9750 commit 7de72fb

11 files changed

Lines changed: 965 additions & 878 deletions

File tree

DEPENDENCIES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,6 @@ To verify you have all dependencies linked correctly:
254254

255255
## Need Help?
256256

257-
- See `README_BUILD.md` for complete build instructions
257+
- See [`docs/building.md`](docs/building.md) for complete build instructions
258258
- Check `CMakeLists.txt` lines 287-381 for the exact CMake configuration
259259
- Open an issue at: https://github.com/livekit/client-sdk-cpp/issues

README.md

Lines changed: 151 additions & 538 deletions
Large diffs are not rendered by default.

README_BUILD.md

Lines changed: 0 additions & 338 deletions
This file was deleted.

docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Repository Documentation
2+
3+
Additional documentation for the SDK.
4+
5+
- [Building](building.md) — prerequisites, build scripts, CMake presets,
6+
vcpkg, Docker, integration into your CMake project, troubleshooting.
7+
- [Logging](logging.md) — compile-time vs runtime filtering, log levels,
8+
custom sinks (file, JSON, ROS2 `RCLCPP_*` macros).
9+
- [Tracing](tracing.md) — Chromium-format performance traces, viewing in
10+
`chrome://tracing` and Perfetto.
11+
- [Testing](testing.md) — unit, integration, and stress test suites; env
12+
vars; token-helper script for local `livekit-server --dev` runs.
13+
- [Developer tools](tools.md)`clang-tidy`, `clang-format`, `valgrind`,
14+
Doxygen, pre-commit hook, Rust submodule recovery tips.

0 commit comments

Comments
 (0)