Resultado da Busca
31 de ago. de 2010 · Saiba por que escrever o README.TXT antes do código pode ajudar a pensar no projeto com antecedência e facilitar a comunicação com a equipe. Confira as dicas do co-fundador do GitHub e leia o texto original aqui.
README. Our simple editor allows you to quickly add and customize all the sections you need for your project's readme. Get Started. Sponsor. Use readme.so's markdown editor and templates to easily create a ReadMe for your projects.
- O Que É Readme? Leia-Me, O Que Seria isso?
- Por Que Fazer Um Readme?
- O Que É Bacana de Se Ter em Um Readme
- Título E Imagem de Capa
- Badges
- Índice
- Descrição Do Projeto
- Status Do Projeto
- Funcionalidades E Demonstração Da Aplicação
- 🔨 Funcionalidades Do Projeto
- GeneratedCaptionsTabForHeroSec
O README é um arquivo com extensão .md, ou seja, ele é escrito em Markdown que é uma linguagem de marcação utilizada para converter o texto em um HTML válido. Caso queira saber mais sobre, temos esse artigoque explica muito bem como funciona e como escrever anotações com essa linguagem. Nas plataformas de repositórios remotos, como o GitHub, a funç...
Depois de trabalhar bastante e desenvolver seu projeto bacana, provavelmente você irá subir para o GitHub e mostrar para comunidade o que você fez. Para isso, é legal documentar o projeto para quem for visitar seu repositório saiba do que se trata, assim como foi visto no primeiro exemplo. E podemos fazer isso por meio do README, que é o primeiro a...
Analisando repositórios famosos, é possível notar a presença de arquivos README bem legais. Como esse repositório Docusaurus do Facebook, que é um projeto feito para auxiliar a construir, implantar e manter sites de projetos de código aberto. E o projeto Open MCT da Nasaque é utilizado para análise de dados de missões de espaçonaves, bem como plane...
Assim que você adicionar um README, ele já irá iniciar com o título sendo o nome do seu repositório. Mas você pode mudar ele e colocar um nome descritivo. Nesse momento abuse da criatividade. Ao escolher o título, você pode colocá-lo dessa maneira: Ou, caso queira colocar ele centralizado, você pode utilizar tags do HTMLque funcionam normalmente, d...
Alguns repositórios utilizam badges, que na tradução literal é distintivo, emblema ou insígnia. Seus objetivos são indicar o estado atual do projeto, licença caso tenha, versões, dependências, testese entre outros. Um exemplo do uso de badges em um repositório do Dropbox, o Dropbox Core SDK for Java 8+: Nele foi utilizado badges para: 1. Licença: I...
O GitHub gera automaticamente um índice para arquivos README, tendo como base os títulos da seção. Para visualizá-lo, selecione o ícone de menuno canto superior esquerdo do arquivo. Principalmente em READMEs extensos, essa é uma ferramenta excelente para navegar pelo documento, pois redireciona o usuário para o tópico selecionado. Entretanto, caso ...
Como é um objetivo do arquivo README descrever o projeto, é legal que você apresente logo após o título ou imagem de capa e/ou Badges caso tenha, uma breve explicação do seu projeto com seu objetivo principal. Você pode adotar uma descrição mais objetiva, como a do Dropbox Core SDK for Java 8+: Ou pode detalhar mais, como feito no projeto GlicoCare...
Caso você opte por não utilizar Badges sobre o status do projeto, é interessante que você coloque essa informação no próprio texto mesmo. Exemplo: Resultado: Ou caso queira centralizar: Nesse exemplo foi utilizado o emoji :construction:, mas você pode utilizar em qualquer lugar do arquivo, como antes dos subtítulos. Nesse Gistdo Rafael Xavier de So...
Você pode listar as funcionalidadesdo seu projeto para facilitar o entendimento do usuário. Para isso, você pode fazer dessa maneira: Resultado:
Funcionalidade 1: descrição da funcionalidade 1Funcionalidade 2: descrição da funcionalidade 2Funcionalidade 2a: descrição da funcionalidade 2a relacionada à funcionalidade 2Funcionalidade 3: descrição da funcionalidade 3Aprenda a criar um arquivo README para apresentar seu projeto no GitHub, com dicas de como usar Markdown, imagens, badges, índice e mais. Veja exemplos de README de projetos famosos e confira as referências para saber mais.
README é uma palavra em inglês que traduzida fica LEIAME. Você já deve ter baixado algum software que tinha um arquivo LEIAME.txt com algumas instruções de como usar. Podemos considerar o README como um cartão de visita do seu projeto no Github ou em outras plataformas de repositórios remotos de código: Gitlab , Bitbucket , Azure Repos .
7 de jan. de 2022 · O que é um arquivo README? De modo simplificado, podemos descrever um arquivo README como um guia que dá aos usuários uma descrição detalhada do projeto em que você trabalhou. Ele também pode ser descrito como uma documentação com diretrizes para usar em um projeto. Em geral, ele terá instruções sobre como instalar e executar o projeto.
Vamos aprender como estruturar um bom README.md. Vou deixar um template e referências interessantes sobre o assunto. Guia Rocketseat para um README de qualidade.
Learn how to create and customize a README file for your GitHub repository to communicate important information about your project. Find out how to use Markdown, relative links, image paths, and wikis in your README.
