# src.WorkspaceReadme

- **Module:** src
- **Package:** libtmux
- **Language:** Rust
- **Kind:** struct
- **Source:** https://github.com/libtmux/libtmux-rs/blob/f0e37052c232636b61d095817046e6bfc8f2ca40/crates/libtmux/src/lib.rs#L466
- **Page:** https://libtmux.org/en/rs/latest/reference/src-workspacereadme/

Compiles the workspace README's examples, and nothing else.

The crate README is the crate documentation, so rustdoc already runs its
examples. The one at the repository root is the page most readers see
first and had no such check, which is how an example that never compiled
sat there. `cfg(doctest)` means this exists only while doctests run, so it
costs a normal build nothing and appears in no documentation.