helllllllder / readmetemplates

Nome do projeto

Descrição curta sobre o que seu projeto faz.

Versões de alguns frameworks ou modulo de gerênciamento de pacotes.

De um a dois parágrafos sobre o que é seu projeto e o que ele faz.

Estrutura do projeto

src
├── Controllers
│ └── HomeController.js
├── index.html
├── Models
│ └── form.js
├── about.html
├── img
│ └── background.png
├── Views
│ ├── Home
│ │ ├── About.cshtml
│ │ ├── Contact.cshtml
│ │ ├── Index.cshtml
│ │ └── Privacy.cshtml

Instalação

OS X & Linux:

npm install my-crazy-module --save

Windows:

edit autoexec.bat

Obter repositório

git clone https://github.com/NomeUsuario/NomeRepositorio.git

Comandos git úteis

git clone - Obter repositório.

git status - checar o estado atual do repositório.

git cheout [NomeDaBranch] - alterar branch do projeto

git add . - adcionar todos os arquivos ao repositório

git commit -m "MinhaMensagemAqui " - Realizar o comitar informando mensagem

git push  origin [NomeDaBranch] - Enviar arquivos/diretórios para o repositório

git pull - Atualizar os arquivos no branch atual

Exemplo de uso

Alguns exemplos interessantes e úteis sobre como seu projeto pode ser utilizado. Adicione blocos de códigos e, se necessário, screenshots.

Para mais exemplos, consulte a Wiki.

Configuração para Desenvolvimento

Descreva como instalar todas as dependências para desenvolvimento e como rodar um test-suite automatizado de algum tipo. Se necessário, faça isso para múltiplas plataformas.

npm install

npm run serve

Histórico de lançamentos

• 0.2.1
  • MUDANÇA: Atualização de docs (código do módulo permanece inalterado)
• 0.2.0
  • MUDANÇA: Remove setDefaultXYZ()
  • ADD: Adiciona init()
• 0.1.1
  • CONSERTADO: Crash quando chama baz() (Obrigado @NomeDoContribuidorGeneroso!)
• 0.1.0
  • O primeiro lançamento adequado
  • MUDANÇA: Renomeia foo() para bar()
• 0.0.1
  • Trabalho em andamento

Meta

Seu Nome – @SeuNome – [email protected]

Distribuído sob a licença XYZ. Veja LICENSE para mais informações.

https://github.com/yourname/github-link

Contributing

1. Faça o fork do projeto (https://github.com/yourname/yourproject/fork)
2. Crie uma branch para sua modificação (git checkout -b feature/fooBar)
3. Faça o commit (git commit -am 'Add some fooBar')
4. Push (git push origin feature/fooBar)
5. Crie um novo Pull Request