/readme-template

Exemplo de arquivo README

Logo

Nome da Aplicação

Breve descrição explicando de forma direta e sucinta o propósito da aplicação



Índice

Índice
  1. Sobre a aplicação
  2. Instalação
  3. Como utilizar
  4. Build Local
  5. Como contribuir
  6. Licença

Sobre a aplicação

Descrição sobre o propósito da aplicação e sobre os problemas que ela se propõe a resolver. Você também pode listar brevemente as funcionalidades principais para depois detalhá-las na seção Como Utilizar. Se necessário, adicione imagens ou GIFs para ilustrar melhor.

app-demo

Principais Tecnologias

Lista das principais tecnologias e frameworks utilizados no projeto. Ideal ter um link para o site da documentação ou para o repositório correspondente. Por exemplo:

Instalação

Informações sobre como instalar a aplicação do ponto de vista de usuário da mesma. Instruções sobre como executá-la localmente e contribuir para o projeto devem ser citadas nas seções Build Local e Como contribuir.

Pré-Requisitos

Liste, caso existam, as tecnologias que deverão ser instaladas para que o usuário consiga utilizar a aplicação. Mostre de forma clara e direta como instalar cada um dos pré requisitos.

Exemplo:

  • npm 
    npm install npm@latest -g

Como instalar

Passo a passo de como instalar a aplicação.

  • Utilizando o npm

    npm i --save nome-da-aplicação

Como desinstalar

Instruções para remover a aplicação.

Como utilizar

Informações mais detalhadas sobre como e quando utilizar as funcionalidades da aplicação, como fazer configurações personalizadas e demais observações importantes relacionadas a esse contexto.

Build local

Instruções sobre como executar a aplicação em um ambiente de desenvolvimento local.

Pré-Requisitos

Liste, caso existam, as tecnologias que deverão ser instaladas para que o usuário consiga executar a aplicação em seu ambiente de desenvolvimento local. Mostre de forma clara e direta como instalar cada um dos pré requisitos.

Como executar

Mostre o passo a passo necessário para executar a aplicação.

Exemplo:

  1. Gere uma chave de acesso gratuita no site https://example.com
  2. Clone o repositório 
    git clone https://github.com/your_username_/Project-Name.git
  3. Installe as dependências 
    npm install
  4. Insira sua chave de acesso no arquivo config.js 
    const API_KEY = "ENTER YOUR API";
  5. Inicialize a aplicação 
    npm start

Como contribuir

Forneça instruções para que as pessoas saibam como contribuir para o projeto. Você pode colocar um link para um guia de contribuição, por exemplo.

Licença

Informe a licença de códido utilizada pelo projeto.