Solucionado (ver solução)

Importante

Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!

Solucionado
(ver solução)
1
resposta

[Dúvida] COMO ESCREVER O README

Estou com dificuldade pra entender como criar o README no meu repositório. Tentei acompanhar pelo artigo disponibilizado mas achei um pouco confuso, não estou conseguindo avançar, tentei usar os negócios que deixam negrito também e acabei não conseguindo. Gostaria de saber se tem algum curso na trilha iniciante que ensine em vídeo também, ou se eu teria que pesquisar por fora. Realmente não consegui fazer somente com o artigo. Foi um pouco frustrante :(

1 resposta
solução!

Oi, Larissa! Tudo bem?

O README é a primeira impressão que as pessoas terão do seu projeto, então é ótimo que você esteja se dedicando a fazer isso da melhor forma.

Para criar um README, você pode usar a linguagem Markdown, que é bem simples e poderosa. Aqui estão alguns passos básicos para te ajudar a começar:

  1. Criação do Arquivo: Normalmente, o arquivo README é chamado de README.md e é colocado na raiz do seu repositório.

  2. Estrutura Básica: Um README geralmente inclui uma descrição do projeto, instruções de instalação, como usar o projeto, contribuições, e informações sobre licenciamento.

  3. Markdown Básico:

    • Para listas, use - ou * para listas não ordenadas, e números para listas ordenadas.
    • Para negrito, use dois asteriscos antes e depois do texto: **texto em negrito**.
    • Para títulos, use o símbolo #. Um # para título maior, dois ## para subtítulos, e assim por diante.

Um exemplo simples de um README:

# Nome do Projeto

Uma breve descrição do projeto.

## Instalação

Instruções de como instalar o projeto.

## Uso

Exemplos de como usar o projeto.

## Contribuições

Como contribuir para o projeto.

## Licença

Informações sobre a licença.

Espero ter ajudado e fico à disposição se precisar.

Abraço e bons estudos!

Caso este post tenha lhe ajudado, por favor, marcar como solucionado