Uma coleção de readme para seus projetos no github.
Disponibilizar para todos de forma acessível vários modelos de readme para desenvolvedores.
Quero simplificar sua vida na hora de documentar um projeto, o readme é algo fundamental para as pessoas entenderem e até colaborar com seus projetos no Github.
🖥️ Modelo 1 | 🖥️ Modelo 2 | 🖥️ Modelo 2 |
---|---|---|
Se você gostaria de compartilhar um modelo de reamde clone esse repositório e faça um pull request do seu modelo, para ser aprovado ele precisa estar estruturado de forma similar a sessão de "🗃️ Estrutura do readme"
Se você puder contribuir com qualquer valor para manter esse repositório sempre ativo clic Aqui
Você pode clonar esse repositório ou simplesmente copiar e colar o código Markdown do readme que você mais gostou ou que combina mais com sua aplicação.
Nosso readme está separado por sessões onde você pode utilizar ou não, tudo vai depender do seu projeto.
Basicamente nossa estrutura consiste em:
-
Apresentação
-
Funcionalidades
- São tópicos descrevendo o que seu projeto tem de interessante
-
Bibliotecas
- Quais bibliotecas você utilizou e porque, o que cada biblioteca adiciona a seu projeto.
-
Rodando o projeto
- Como rodar seu projeto, muita atenção nesse ponto, pense em alguém que não domine totalmente aquela tecnologia para fazer esse passo a passo.
-
Tecnologías Utilizadas
- Coloque cada stack que você utilizou no seu projeta, use o Dev Icons para pegar as imagens das suas tecnologias.
-
Status do projeto
- Coloque as etapas pendentes e as que estão prontas do seu projeto ou divida em etapas como: "Design", "Desenvolvimento", "Testes", "Deploy".
-
Contribua com esse projeto
- Caso seu projeto precise de contribuição financeira você pode usar esse espaço para explicar como as pessoas podem te ajudar a continuar seu projeto.
-
Aprendizados
- Descreva o que você aprendeu com seu projeto.
-
Agradecimentos
- Faça uma mensão as pessoas ou tutoriais que ajudaram a construir seu projeto.
-
Vamos nos conectar?
- Compartilhe suas redes sociais para as pessoas te encontrarem.
Faca um pull request nesse repositório e compartilhe o seu nome, tipo de projeto e o link para um repositório que utiliza um dos nossos templates.
Dener Garcia - Front-end Gabriel Moscarde - Python Application - PyProductivity