My Readme Boilerplate

README-pt_br.md

Meu Readme Boilerplate

Um modelo das melhores práticas do README para tornar o meu README simples de entender e fácil de usar.

Índice

• Instalação
• Uso
• Exemplos
• Suporte
• Contribuindo
• History
• License

Instalação

Faça o download para o diretório do seu projeto, adicione README.md e confirme:

# Escreva a instalação aqui

Uso

Substitua o conteúdo de README.md pelo seu projeto:

• Nome
• Descrição
• Instruções de instalação
• Instruções de uso
• Instruções de suporte
• Instruções de contribuição

Exemplos

Exemplo 01

# Escreve o exemplo 01 aqui

Exemplo 02

# Escreve o exemplo 02 aqui

Sinta-se à vontade para remover qualquer seção que não seja aplicável ao seu projeto.

Suporte

Por favor, abra uma issue para suporte.

Contribuindo

Por favor, contribua usando Github Flow. Crie um branch, adicione commits, e abra um pull request (PR). Contribua!

1. Fork este repo!
2. Crie sua branch de feature: git checkout -b minha-nova-feature
3. Commit suas alterações: git commit -m 'Adicionando mais uma alteração'
4. Envie sua branch para sua origin: git push origin minha-nova-feature
5. Envie um pull request :D

History

Veja as Releases para o changelog detalhado..

Autor

Fernando Moreira

Licença

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

Código está sob a licença MIT - © Fernando Moreira

Me pague um café?

Isso me encorajará a continuar, consertar qualquer bug que você encontrar e passar o tempo melhorando: D

README.md

My Readme Boilerplate

A template of README best practices to make my README simple to understand and easy to use.

Table of Contents

• Installation
• Usage
• Examples
• Support
• Contributing
• History
• License

Installation

Download to your project directory, add README.md, and commit:

# Write installation here

Usage

Replace the contents of README.md with your project's:

• Name
• Description
• Installation instructions
• Usage instructions
• Support instructions
• Contributing instructions

Examples

Example 01

# Write Example 01 here

Example 02

# Write Example 02 here

Feel free to remove any sections that aren't applicable to your project.

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request. Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

History

See Releases for detailed changelog.

Author

Fernando Moreira

License

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

Code is under MIT License - © Fernando Moreira

Buy me a coffee?

It will encourage me to keep it going, fix whatever bugs you find and spend time making it better :D