quando escrevo um leia-me para projetos maiores, certifico-me de incluir algumas coisas
uma estrutura de diretório / arquivo: eu uso árvore uma ferramenta de linha de comando do Unix para imprimir uma estrutura de arquivo do diretório do projeto e colocá-lo dentro de tags de pré-código para obter uma estrutura bem formatada
meu botão de endosso do coderwall: por razões óbvias
uma seção de equipe de crédito / dev: basta listar todos os envolvidos no desenvolvimento