Categorias

o-android-13-tem-codinome-interno-vazado-a-aposta-agora-e-a-sobremesa-tiramisu

Android

Games

Notícias

Tutoriais Linux

Vídeos

Dica

27/04/2021 às 08:00

9 min leitura

Avatar Autor
Por Glauber GF

Como Criar o README do Seu Projeto

Como Criar o README do Seu Projeto

Muitos se perguntam o que é o README. Com isso, veja nessa dica como criar o README do seu projeto. O README é um arquivo de texto que apresenta e explica um projeto. Ele contém informações que normalmente são necessárias para entender do que se trata o projeto.

O README pode ser escrito em qualquer formato de arquivo de texto, logo, o mais comum usado atualmente é o Markdown (linguagem de marcação leve para criar texto formatado usando um editor de texto simples). Ele permite que você adicione alguma formatação leve.

Markdown é uma maneira simples de formatar texto que fica bem em qualquer dispositivo. Ele não faz nada sofisticado, como alterar o tamanho, a cor ou o tipo da fonte, apenas o essencial, usando símbolos de teclado que você já conhece. Você pode aprender mais sobre Markdown acessando o guia de referência útil.

Existem plug-ins para muitos editores (Atom, Emacs, Sublime Text, Vim e Visual Studio Code) que permitem que você visualize o Markdown enquanto o edita.

Como Criar o README do Seu Projeto

Veja agora uma sugestão de como criar um bom README. Nesse caso, vou criar o README para um projeto de estudo inicial que fiz que esta no GitHub e postado na dica Como instalar e configurar o Zabbix 5 no Debian 10 com Ansible.

Como Criar o README do Seu Projeto

Cabeçalho de Nome

Escolha um nome autoexplicativo para o seu projeto e uma descrição.

Formate o cabeçalho1 adicionando o ‘#’ e deixe destacadas algumas palavras de acordo com sua necessidade, sendo assim, destaques em negrito ‘**texto**’ e itálico ‘_texto_’ conforme mostrado abaixo.

# Instalar e Configurar o Zabbix com o Ansible

O **Zabbix** é um software de nível corporativo ideal para o monitoramento em tempo real de milhões de métricas coletadas de dezenas de milhares de servidores, máquinas virtuais e dispositivos de rede, além de ser de código aberto é também gratuito.

O **Ansible** trabalha com os conceitos de inventário (_lista de máquinas que serão gerenciadas_), playbooks (_comandos ou passo-a passo a ser executado_) e roles (_modularização do código_). Atualmente o Ansible pertence a **Red Hat**.

Cabeçalho de Uso

Nesse cabeçalho mostre as ferramentas necessárias para o seu projeto.

Formate como cabeçalho2 adicionando o ‘##’, destaques em negrito ‘**texto**’ e itálico ‘_texto_’ com links de referências ‘[texto](link)’ conforme mostrado abaixo.

## O Host 

Para esse projeto local, foi utilizado o Host com o GNU/Linux Debian Buster e realizado a instalação dos seguintes programas (ferramentas) para a execução do projeto:

**[Vagrant](https://www.vagrantup.com/docs)** para provisionar uma VM (_máquina virtual_) e instalar o Sistema Operacional **[GNU/Linux Debian Buster](https://www.debian.org/)** nessa VM. Lembrando que o _Vagrantfile_ utilizado nesse projeto esta setado para o uso do **[libvirt - Virtual Machine Manager](https://virt-manager.org/)**.
 
**[Ansible](https://docs.ansible.com/ansible/latest/index.html)** para executar o gerenciamento de automação na máquina alvo, nesse caso a VM com o Debian.
 
O Artigo de referência que seta este Projeto esta no **[SempreUpdate](https://sempreupdate.com.br/como-instalar-e-configurar-o-zabbix-5-no-debian-10-com-ansible/)**. 

Cabeçalho de Automação

Já nesse cabeçalho mostre alguns destaque do seu projeto e o que ele faz.

Formate como cabeçalho4 adicionando o ‘####’ e destaques os textos com ” ‘ ‘ ‘texto’ ‘ ‘ ” conforme mostrado abaixo.

#### A Automação

Veja a breve descrição das tasks dentro da playbook:

```
ajustar o timezone
alterar o idioma
alterar o layout do teclado
instalar, configurar e habilitar o NTP
instalar, configurar e habilitar o MariaDB
instalar, configurar e habilitar o Zabbix
instalar, configurar e habilitar e o Nginx
```

Explore as tasks e sinta-se a vontade para melhora-lá. 

Cabeçalho de Contribuição e Licença

Já nesses cabeçalhos informe se esta aberto a contribuição para o projeto e sua licença.

Formate como cabeçalho3 adicionando o ‘###’, destaques em negrito ‘** texto **’ e itálico ‘_ texto _’ com links de referências ‘[texto](link)’ conforme mostrado abaixo

## Contribuindo
 
Para contribuição de melhorias no código, comente no projeto as devidas alterações deixando explicadas e assim que for possível faço o commit e o merge para o código.
 
Esse foi um projeto inicial de estudo, logo, não foi utilizada as boas práticas.
 
## Licença
 
**GNU General Public License** (_Licença Pública Geral GNU_), **GNU GPL** ou simplesmente **GPL**.
 
[GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 

Para criar o seu README com o Markdown, acesse a página makeareadme e veja como fica o seu README no exato momento de sua criação.

Como Criar o README do Seu Projeto

Espero que essa dica ajude na criação dos README’s dos seus projetos.

Até a próxima!!!

Usuário de GNU/Linux desde 2002, graduado em Sistemas de Informação, entusiasta na cultura DevOps.

Últimos artigos

Newsletter

Receba nossas atualizações!

Newsletter

Receba nossas atualizações!
  • Este campo é para fins de validação e não deve ser alterado.