Skip to content

README.md

Latest commit

 

History

History
66 lines (45 loc) · 2.35 KB

README.md

File metadata and controls

66 lines (45 loc) · 2.35 KB

Nome do Projeto/produto que está realizando

Um Screenshot do projeto em funcionamento

Uma pequena descrição sobre o que é o projeto/produto

Você também pode adicionar alguns badges/states ao lado de Nome do projeto, por exemplo, os ofertados pelos serviços:

Como usar

Uma breve descrição de como usar o que foi feito.

Requerimentos

Descreva o que a aplicação precisa para funcionar.

  • ionic x.x
  • lib não sei das quantas...

Descrever como uma observação Obs: o motivo da utilização de cada lib extra do projeto.

Instalar

Passo a passo para instalar a aplicação! Exemplo:

npm install  --save

Rodar

Descreva aqui como que é o procedimento para rodar a aplicação.

make install
npm test

Descrição do(s) autor/autores

Aqui você pode incluir uma descrição sobre você, sobre suas redes sociais etc...

Licença

MIT Relatar aqui o tipo da licensa na qual o projeto tem ex: MIT, GNU, ou qualquer que seja!

Obs: Caso o projeto seja pequeno e por algum motivo escolha não usar a wiki, pode-se fazer uma breve documentação com outros detalhes de instalação e de uso, complementares a descrição exposta nesse arquivo Readme.md, detalhando outros pontos importantes, seguindo o arquivo DOC.md e ir adicionando itens de acordo com a necessidade.

Comentários

Por favor, abra uma issue para suporte.

Como contribuir

  1. git clone (https://github.com/caminhodorepositorio.git)
  2. Crie uma branch (git checkout -b seunome-alteração)
  3. Faça Commit das alterações (git commit -am 'adicione um comentario sobre as alterações')
  4. Faça um Push (git push origin seunome-alteração)
  5. Crie um pull request, existem mais de uma maneira para reaizar este procedimento, um método facil é se dirigir ao código e clicar no botão pull request após ter feito o push e assim solicitar!