Aula 7: O Cartão de Visitas (README.md)

Por: Nerd Toolkit Postado em: Julho 15, 2026 Visto por: 2

No mundo do desenvolvimento, o arquivo README.md é o manual de instruções rápido. Quando alguém entra no seu projeto no GitHub, a primeira coisa que aparece na tela é o conteúdo desse arquivo.

A extensão .md significa Markdown, uma linguagem super simples para formatar textos usando símbolos no teclado (para criar títulos, negritos e listas).

A Estrutura Ideal Um bom README deve responder a três perguntas fundamentais:

  1. O que é esse projeto?

  2. Quais tecnologias e ferramentas foram usadas?

  3. Como eu faço para instalar e rodar isso no meu computador?

Exercício Prático: Montando a Vitrine

  1. Na pasta principal do projeto, crie um arquivo chamado exatamente README.md.

  2. Adicione o seguinte texto usando a formatação Markdown:

    # Construcom Logística
    Um sistema focado em gestão de rotas, controle de frota e frente de caixa (PDV).
    ## Tecnologias Utilizadas
    * PHP 
    * Banco de Dados MySQL
    * Git e GitHub
    ## Como Rodar o Projeto
    1. Faça o clone deste repositório na sua máquina.
    2. Coloque a pasta do projeto dentro do seu servidor local (XAMPP).
    3. Inicie o servidor e acesse a rota principal no navegador.
  1. Salve o arquivo no terminal usando o ciclo de vida:

    git add README.md
    git commit -m "Cria arquivo README com a documentacao do projeto"

Notícias Relacionadas

Aula 7: O Cartão de Visitas (README.md)
  Contato
  • support@nerdtoolkit.com.br
Mapa do Site
Mostrar mapa do site
  Sobre

Feito de programadores para programadores.

Este site utiliza cookies. Ao continuar a utilizar este site, você concorda com a nossa utilização de cookies e política de privacidade.
Leia mais Concordo