Sobre | Tecnologias | Requisitos | Como Contribuir | Iniciando | Colaboradores | Licença
O ReadME Maker é uma aplicação feita para auxiliar desenvolvedores a construirem o README.md dos seus projetos. Com o intuito de facilitar a criação do texto, são feitas algumas perguntas sobre o projeto, apresentando ao final da aplicação todo o markdown pronto para ser implementado no arquivo README.md do seu projeto no GitHub.
O projeto foi desenvolvido utilizando as seguintes tecnologias:
- NodeJS 10.x
- NPM ou Yarn
Todos são bem vindos para colaborar com o projeto! Para isso:
- Faça um Fork do repositório
- Faça um clone do respositório criado a partir do seu fork
- Crie uma branch
- Faça um commit
- Faça um push
- Crie a PR
Mantendo o seu fork atualizado:
- Clone o seu fork
git clone https://github.com/seuusuario/readme_maker.git - Adicione um remote para o repositório original
git remote add nomedabranch - Atualize o remote
git fetch nomedabranch - Faça o rebase do master com o master do remote
git rebase nomedabranch/master
Seu fork está atualizado!
Clonando o repositório:
$ git clone https://github.com/lucas-felinto/readme_maker.git
Download das dependências:
Direcione-se para a raíz do projeto
npm install
Executando
No modo desenvolvimento:
npm run dev
No modo produção:
npm run start
Colaboradores Wemerson Jesus |
 Maicon Boer |
 José Eduardo |
 Felipe Schiavon |
 Vinicius Kammradt |
 Robson Mendonça |
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.