Skip to content

Crate README inventory

Crate and package README files remain canonical at their package paths because crates.io, IDEs, and repository browsers expect them there. The docs site links them and hosts cross-cutting guides separately.

READMEPurpose
crates/ferrex-contracts/README.mdTrait surfaces and domain contracts built atop ferrex-model.
crates/ferrex-model/README.mdShared media, library, user/auth, and metadata models.
crates/ferrexctl/README.mdConfiguration bootstrapper and packaging CLI usage.
crates/ferrex-player/README.mdDesktop player facade, runtime notes, screenshots, validation, HDR, and Flatpak notes.
crates/ferrex-player-foundation/README.mdDependency-light player primitives and boundary policy link.
crates/ferrex-player-repository/README.mdPlayer-side media repository overlays and server-scoped disk cache support.
crates/ferrex-player-ui/README.mdDesktop presentation layer during player crate decomposition.
crates/ferrex-core/tests/README.mdCore test suite and scanner runtime regression commands.
crates/ferrex-server/tests/README.mdServer E2E and scanner regression-suite commands.

For cross-crate architecture, use Architecture. For player dependency direction and guard policy, use Player dependency boundaries.