From 08cdf6186e22c24811f04296c0455e8dffc4bbef Mon Sep 17 00:00:00 2001 From: Gilberto Caetano de Andrade Date: Tue, 20 Nov 2018 11:42:58 -0300 Subject: [PATCH] Readme para ajudar a contribuir #236 --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index efaf43620..5a936826a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,33 @@ # Caelum Stella -![Build status](https://secure.travis-ci.org/caelum/caelum-stella.png) - Alguns processos são comuns e recorrentes em sistemas voltados para o público brasileiro. O Stella vai te auxiliar nesse caso, oferecendo uma API simples para validação e formatação de CPF, CNPJ e outros cadastros comuns no Brasil. Além de oferecer uma API para trabalhar com boletos, números e integração com JSF, JPA/Hibernate etc. -Consulte a documentação: +### Build status + * TravisCI: + * [![Build Status](https://travis-ci.org/caelum/caelum-stella.svg?branch=master)](https://travis-ci.org/caelum/caelum-stella) + * Apache Jenkins: + * Linux: [![Build Status](]() + * Windows: [![Build Status]()]() + +### Requirements + + * Git + * Maven 3.5 or above + * Oracle JDK 7 or OpenJDK 7 + +### Building -https://github.com/caelum/caelum-stella/wiki +Fork este repositório +Vá para a página do projeto forked e clone o mesmo em seu computador via ```git clone link-to-your-forked-repo-here``` +Digite ```git remote -v``` confirmando que **origin** aparece e aponte para o repositório remoto que fez o fork +Em seguida, digite ```git remote add upstream https://github.com/caelum/caelum-stella.git``` +Verifique novamente via ```git remote -v``` +Certifique-se que **origin** e **upstream** estejam configurados +Pronto, use seu IDE ou o maven +``` +$ mvn install +``` -E a página de downloads e configuração de dependência via Maven: +### Running -https://github.com/caelum/caelum-stella/wiki/Download +Use o artefato construído, colocando-o no classpath de sua aplicação através do maven ou diretamente