Descrição
Conteúdo README pode ser gerado a partir de comentários de documentação Rust em uma crate. É útil para mantenedores que querem manter a documentação pública do projeto próxima dos docs no código-fonte.
Ele grava saída de documentação. Revise o README gerado antes de commit, porque comentários rustdoc podem precisar de contexto, exemplos ou edição para leitores fora do código.