Opa, tudo bem? Resolvi criar essa apostila para ajudar os alunos da turma do #OTechTáOn 🥰
Nela, você vai aprender sobre:
- 🎨 Como personalizar o seu README
- 🖥️ Como instalar o GIT
- 👩🏻💻 Como puxar um arquivo para o GIT
- 🥰 Agradecimentos e créditos
Espero que goste e que eu consiga te ajudar, estou aceitando feedbacks de melhorias sempre!
Como personalizar o seu README (🔝 Voltar ao topo)
🎥 Clique aqui para assistir o tutorial no youtube
Você já deu uma olhada no meu? Se não, clica nesse link para ver.
E aí? Gostou? Quer aprender a fazer? Então segue o passo a passo (bem detalhado) abaixo! 😁
(Ex: se o seu nome for fulanodetal, coloque no repositório o nome fulanodetal)
Você vai saber que escreveu seu nick corretamente quando aparecer esse textinho
4. Depois de criado o arquivo, clique no lápis onde eu sinalizei em vermelho para você. Ele vai te levar para a edição do arquivo.
Para mais opções de personalização, recomendo que acesse esse link.
Para criar um título, adicione de um a seis símbolos # antes do texto do título. O número de # que você usa vai determinar o tamanho do título.
# O título maior
## O segundo maior título
### O terceiro maior título
###### O título menor
| Estilo | Sintaxe | Exemplo | Resultado |
|---|---|---|---|
| Negrito | ** ** ou __ __ |
**Esse texto está em negrito** |
Esse texto está em negrito |
| Itálico | * * ou _ _ |
*Esse texto está em itálico* |
Esse texto está em itálico |
| Tachado | ~~ ~~ |
~~Esse texto estava errado~~ |
Você pode criar uma lista não ordenada colocando - ou * antes do seu texto.
- Batata
- Arroz
- Carne
- Batata
- Arroz
- Carne
Para ordenar a lista, coloque um número na frente de cada linha.
1. Batata
2. Arroz
3. Carne
- Batata
- Arroz
- Carne
Você pode adicionar emojis digitando :NOMEDOEMOJI:
Maaaas, caso você esteja no Windows, pode apertar as teclas
Windows+Rque vai abrir uma lista de emojis! 🤯
Provavelmente essa é a parte mais legal e que vocês mais querem fazer, certo?
🤷🏻♂️: Rebeca? O que é badge?
Bom, badge é isso:
🤷🏻♂️: Uau, muito daora, dá uma colorida legal no README!
Nesse link aqui, você vai encontrar várias badges personalizadas, tanto de contato como softwares e linguagens de programação.
🤷🏻♂️: Ok, mas como colocá-las para aparecer no meu README?
Para mostrar o badge no seu perfil, você precisa entender que ele é uma imagem. Você pode simplesmente colar a imagem aqui no código, mas não vai ficar tão legal, né? Para deixar bonitinho e aparecer o título da imagem quando você passar o mouse em cima do badge, você pode usar title.
🤷🏻♂️: Tá, mas como eu faço tudo isso?
É bem tranquilo, você deve usar o código: <img src="SEU-LINK" title="SEU-LINK"> ou , substituindo SEU-LINK e título pelo link e nome certos, claro.
Aqui vai um exemplo da badge do VS Code:
<img src="https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white" alt="VS Code" title="VS Code">
Muito legal, né? Inclusive, como eu já falei antes, no link que eu botei acima, tem muitas outras badges super legais. Todos os parabéns para o @alexandresanlim e a galera que ajudou ele! 👏🏻
Acesse esse link para ver um tutorial em português de como usar cards!
Caso você ainda esteja com dúvidas e/ou precisando de ajuda, me manda uma mensagem! Você também pode clonar meu README se quiser, aí você já tem uma base 😉
Como instalar o GIT no seu PC (🔝 Voltar ao topo)
Caso você não saiba o que é o GIT, o site da Atlassian descreve ele nos mínimos detalhes 😆
O GIT é um sistema de controle de versão desenvolvido por Linus Torvalds, o mesmo que criou o Linux. Muitos projetos de software, comerciais e de código-fonte aberto dependem do Git para o controle de versão, por isso é importante que você, durante sua carreira de desenvolvedor, conheça e utilize o sistema.
Ou seja, em vez de ter apenas um único local para o histórico completo da versão do seu software, no Git, a cópia de trabalho de todo desenvolvedor do código também é um repositório que pode conter o histórico completo de todas as alterações.
Mas, enfim, como instalar o GIT?
1. Entre no site do GIT
Ao entrar, dependendo de qual é o sistema operacional do seu computador, selecione-o na seção de downloads
Como eu uso Windows, cliquei no nome dele.
Assim que você entrar na tela do sistema que escolheu, o download começará automaticamente e te pedirão para salvar o Git.exe, você pode colocá-lo em qualquer lugar que desejar.
Obs: se o seu download não começar, clique aqui:
Depois que o arquivo terminar de ser baixado, clique duas vezes para abrir.
O seu computador vai pedir autorização para abrir o arquivo, então clique em Sim
Logo, essa janela abrirá para você:
Clique em Next
Selecione o local onde você quer instalar o seu GIT e clique em Next
Nessa janela, tem várias opções de componentes do GIT que podem ser instalados. Você pode escolher o que quiser e depois é só clicar em Next
Não se esqueça de marcar a opção Windows Explorer integration, senão você não vai conseguir abrir seu git bash corretamente!
Agora, você também pode dizer se quer que o GIT tenha sua própria pasta no menu iniciar ou não. Caso você não queira, é só clicar em Don't create a Start Menu folder.
Depois, clique em Next novamente.
Você deve selecionar o editor de texto que deve ser utilizado para editar os conflitos que possam aparecer no seu GIT. Eu recomendo que você selecione o Visual Studio Code (sem ser o Insiders), mas é claro que você é livre para escolher o que quiser.
Para quem não conhece muito o GIT, as próximas partes podem ser confusas.
Você deve dizer para o GIT, agora, qual será o nome da sua branch inicial.
Eu recomendo que você marque a primeira opção, para deixar que o GIT decida isso para você.
Nessa parte, você deve selecionar o que está marcado na foto. O instalador do GIT nos pergunta qual será o ambiente PATH. O PATH é o conjunto padrão de diretórios incluídos quando você executa um comando na linha de comando.
Selecione a opção do meio (que é a recomendada) e clique em Next
Agora, marque a primeira opção em todas as próximas telas:
Marque apenas a primeira opção nesta tela:
Aqui você não marca nenhuma:
Depois, de instalado, selecione para abrir o GIT Bash
Prontinho, o seu GIT já vai estar instalado no seu computador!
Como puxar arquivos do GIT para o GitHub (🔝 Voltar ao topo)
Quer puxar um arquivo direto para o GitHub pelo GIT e não sabe como? Siga os passos abaixo!
Só vale se você criou um arquivo/projeto no seu navegador!
Ainda não tem o GIT no seu computador? Baixe-o clicando neste link.
2. Coloque o nome do repositório que você desejar (lembre-se de o nome estar escrito corretamente (sem espaços!)
Você pode enviar um arquivo clicando em
uploading an existing file, mas que tal tentar usando a linha de comando?
6. Com o botão direito do mouse, clique em qualquer lugar da pasta (exceto nos arquivos) e selecione a opção Open GIT Bash here
Caso você esteja no Windows 11 e essa opção não apareça para você, ao clicar com o botão direito, clique em Mostrar mais opções.
Agora, se nenhuma opção do GIT aparecer, certifique-se de que você instalou o GIT corretamente.
7. Quando você clicar para abrir o GIT Bash, essa tela aparecerá para você (com as suas informações)
Provavelmente isso aparecerá na sua tela:
Você pode digitar git status para saber quais arquivos estão disponíveis para serem comitados
Caso queira adicionar todos os arquivos de uma vez, digite git add .. Se quiser adicionar apenas um, digite git add nomedoarquivo com o nome do arquivo que você deseja anexar.
No meu caso, eu dei git add . e adicionei todos de uma vez.
🤷🏻♂️: Quê? O que é um commit?
Segundo o nosso pai Wikipedia, commit refere-se ao processo de tornar permanente um conjunto de alterações, ou seja, de efetivar as alterações. Traduzindo: o commit permite que você guarde todas as suas alterações naquele momento, ou seja, você consegue guardar o estado do seu repositório.
Digite git commit -m, escreva o seu primeiro commit e dê enter (não se esqueça das aspas!)
Veja como eu escrevi:
Se der algum erro durante o passo a passo para você, certifique-se de que seguiu todos os passos corretamente!
Caso ainda esteja com erros, me mande uma mensagem, quem sabe eu não posso te ajudar? 😉
Você verá que seus arquivos já estarão dentro do seu repositório do GitHub, eba! 🥳
Agora, já sabe, né? Não se esqueça de praticar, que tal fazer isso com todos os seus arquivos de agora em diante? Quem não pratica, não aprende!
Agradecimentos e créditos (🔝 Voltar ao topo)
Espero que você tenha gostado do conteúdo e que eu tenha conseguido te ajudar com o GIT e o GitHub, sério. 🥺
Agradecimentos:
- Alura e sua equipe de professores, por todo o conhecimento ensinado
Créditos e fontes: