Como Construir um README PADRÃO

Nome do projeto

Um resumo curto sobre oque seu projeto faz: linguagem de programação usadas etc...

um dou dois parágrafos sobre seu projeto e oque ele faz.

Instalação

OS X & Linux:

    npm install  --save
    

Windows:

    edit autoexec.bat

Exemplo de uso do seu projeto

Alguns exemplos que motivariam as pessoas a utilizarem seu projeto ou que demostrasse que este projeto seria util.

divida essa parte em parte menores, pode colocar prints de tela da aplicação etc.

Ambiente de desenvolvimento

Descrever como instalar e preparar qualquer depedência de desenvolvimento para que seu projeto posso ser executado localmente e as pessoas possam contribuir com o mesmo. se possivel forneça as informações para diferentes plataformas, exemplo Windows, Linux e Mac OS.

Histórico de atualização

• 0.2.1
  • CHANGE : Atualicação dos docs (o código detalhado)
• 0.2.0
  • CHANGE: Removida função padrao do projeto padrao().
  • AD: Adicionado a funcão Inicializar()
• 0.1.1
  • FIX: Crash quando executava escrever() (obrigado ao @contribuidor)
• 0.1.2
  • O primeiro lançamento estável do projeto
  • CHANGE: Renomeado o projeto Projeto x para Projeto Y

Meta

Meta são as metas informações do desenvolvedor

Seu nome - @seuTwiter

seu email -seuemail@gmail.com

Distribuído sobre a licença. Veja Licença para mais informações

https://github.com/Maia1111/geek-git1.git