Template para personalizar readme dos projetos da Alura. O objetivo deste template é auxiliar as pessoas que pretendem criar readmes mais informativos e descritivos. Considere esse modelo como base, mas se preferir, ajuste os detalhes conforme sua necessidade e caso queira, confira esse artigo que ensina a personalizar readmes em geral.
Mobile
Front-end
Ao criar o seu readme, remova todas as informações acima e mantenha apenas a imagem de capa e o conteúdo restante a partir do título "Nome do projeto".
Adicione a imagem de capa com o tema do seu projeto:
Você pode pegar a imagem a partir deste template.
Ou gerar neste site.
Após adicionar a imagem, também modifique as configurações do projeto para garantir que a imagem vai ser carregada como thumbnail:
Settings > Options > Social preview > Edit > Upload an image...
Demonstração da adição de thumbnail
Descreva o que é o projeto e o que ele faz
Indique quais são as funcionalidades e comportamentos do App
Se possível, apresente um exemplo visual do projeto, seja gif, imagens ou vídeo, abaixo segue um exemplo:
Faça uma lista de tecnologias e técnicas utilizadas (a justificativa e descrição são opcionais):
Funcionalidade 1: descrição da funcionalidade 1Funcionalidade 2: descrição da funcionalidade 2Funcionalidade 2a: descrição da funcionalidade 2a relacionada à funcionalidade 2
Funcionalidade 3: descrição da funcionalidade 3
Indique como é possível baixar ou acessar o código fonte do projeto, seja projeto inicial ou final
Apresente as instruções necessárias para abrir e executar o projeto
Faça um CTA (call to action) para o curso do projeto