Descrição
Arquivos README podem ser gerados a partir de comentários de documentação Rust em uma crate. É útil para mantenedores que querem manter a documentação do projeto próxima do texto-fonte do rustdoc.
Ele grava arquivos de documentação no repositório. Revise o README gerado antes de commit, porque comentários de código podem precisar de edição para uma visão pública do projeto.