Para que serve o README no GitHub?
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.O que colocar no README?
O que é README? Leia-me, o que seria isso?
- Descrição do seu projeto;
- Funcionalidades;
- Como os usuários podem utilizá-lo;
- Onde os usuários podem encontrar ajuda sobre seu projeto;
- Autores do projeto.
Onde fica o README no GitHub?
GitHub mostra o README do seu perfil na parte superior da sua página de perfil. Você decide quais informações incluir no README do seu perfil. Portanto, você tem total controle sobre a forma como se apresenta no GitHub.Como fazer um bom README de um projeto?
Estrutura do README
- Logo ou Banner.
- Título e Descrição.
- Badges.
- Status do Projeto.
- Tabela de Conteúdos.
- Features.
- Demonstração da Aplicação.
- Pré-requisitos e como rodar a aplicação/testes.
Como personalizar o seu perfil no Github (Readme)
Como criar um README GitHub bonito?
6 passos para criar um README bonitão de perfil no GitHub!!
- Crie um novo repositório com o mesmo nome de seu usuário.
- Role para baixo e marque a opção Add a README file. ...
- Agora volte para a guia Repositórios e clique no repositório recém-criado.
- Você encontrará uma prévia do arquivo README.md.
Como colocar um link no README do GitHub?
Links. Você pode criar um link embutido colocando o texto do link entre colchetes [ ] e colocando a URL entre parênteses ( ) .Qual a extensão do arquivo README?
Um README é um arquivo com extensão md, ou seja, ele é escrito em Markdown.O que é a linguagem Markdown?
Markdown é um formato de simples de markup, isso é, de marcação de texto. A ideia é marcar um texto informando o que é importante, o que é um tópico, o que são links e imagens, sem a necessidade de utilizar marcações mais complexas, como o HTML.Como documentar um projeto para o GitHub?
O que sua documentação deve ter?
- Descrição breve do projeto.
- Escrever sobre qual problema o seu projeto resolve.
- Instruções de instalação e execução.
- Instruções sobre "como contribuir" com o projeto.
Como melhorar o perfil do GitHub?
Nomeie o repositório com o seu nome de usuário do GitHub.
- Escreva uma breve descrição sobre você Fale um pouco sobre você. ...
- Cite suas skills e redes sociais utilizando Badges. ...
- Adicione uma ilustração ou imagem que você se identifique. ...
- Defina uma paleta de cores harmônica. ...
- Adicione o GitHub Stats.
Como quebra linha no README?
Você pode usar a tag <br/> para forçar uma quebra de linha. O espaço duplo, em seguida, se você quiser fazer uma nova linha se houver problemas para criar novas linhas. Ver não é tão bom como praticar. Você pode criar um arquivo de markdown para você praticar ou fazê-lo online aqui.O que colocar no perfil do GitHub?
Você pode adicionar informações pessoais sobre si mesmo na bio, como locais em que trabalhou anteriormente, os projetos com os quais contribuiu ou interesses que você tem que outras pessoas talvez gostem de saber. Para obter mais informações, confira "Personalizar seu perfil".Como inserir uma imagem no README?
Incorporar a imagem diretamente no README:URL_da_Imagem : Substitua isso pela URL da imagem que deseja incorporar. A imagem deve estar hospedada online, como no próprio repositório, em um serviço de hospedagem de imagens, ou em qualquer outro local acessível pela internet.
Como colocar ícones no README do GitHub?
Para adicionar imagens ou gifs no README é necessário colocar o arquivo . png, . jpeg ou . gif desejado em uma pasta dentro do repositório do GitHub.Como excluir um repositório no GitHub?
Excluir um repositório
- No GitHub.com, navegue até a página principal do repositório.
- Abaixo do nome do repositório, clique em Configurações. ...
- Na página de configurações "Geral" (que é selecionada por padrão), role para baixo até a seção "Zona de perigo" e clique em Excluir este repositório.
Como montar uma tabela em Markdown?
Para definir uma tabela, use as seguintes regras:
- Separe colunas com barras verticais (|)
- Insira barras verticais (|) em ao início e fim da tabela.
- Separe o título das colunas do conteúdo com uma linha de demarcação contendo pelo menos três traços (-)
Como fazer um parágrafo em Markdown?
Um parágrafo não requer sintaxe especial no Markdown. Para formatar o texto como negrito, coloque-o entre dois asteriscos. Para formatar o texto como itálico, coloque-o entre um único asterisco: This text is **bold**.Como escrever código no Markdown?
Código (Code Highlight)Há dois modos de adicionar trechos de código ao Markdown: Código em linha (inline): adicione um acento grave ˋ no início e no final do código. Múltiplas linhas de código: envolva as linhas de código com três acentos graves ˋˋˋ ou três tils ~~~ .