diff options
Diffstat (limited to '')
| -rw-r--r-- | README | 27 |
1 files changed, 16 insertions, 11 deletions
diff --git a/README b/README index 8ce74fd..7e3f4d0 100644 --- a/README +++ b/README @@ -1,10 +1,12 @@ -Jitterbug : A continuous integration system built on Dancer and git hooks +## Jitterbug : Cross Language Continuous integration for Git + + +### What is Jitterbug? Jitterbug is written in Perl 5 and depends on various CPAN modules, such -as Dancer, DBIx::Class and Git::Repository. +as Moose, Dancer, DBIx::Class and others. -Installing Jitterbug -=================== +### Installing Jitterbug perl Build.PL @@ -12,19 +14,22 @@ perl Build.PL # install dependencies # perl Makefile.PL -# install missing dependencies -./Build installdeps + # install missing dependencies + ./Build installdeps + + # Look at config.yaml or example.yaml for how to configure your Jitterbug instance + $EDITOR config.yaml -# start the jitterbug Dancer app, which by default binds to port 3000 -perl jitterbug.pl + # start the jitterbug Dancer app, which by default binds to port 3000 + perl jitterbug.pl -# If you need to start it on a different port use -p -# perl jitterbug.pl -p 3001 + # If you need to start it on a different port use -p + perl jitterbug.pl -p 3001 In another terminal, deploy a DBIx::Class schema ( which is SQLite by default, change the values in config.yml to tweak) : -perl scripts/jitterbug_db --config config.yml --deploy + perl scripts/jitterbug_db --config config.yml --deploy Now add a post-receive hook to your github project that hits the /hook/ URL on the server that the jitterbug Dancer app is running on, i.e. |