From 3d3f2e2e20addc4035a4e86f2675780a446849e4 Mon Sep 17 00:00:00 2001 From: "Jonathan \"Duke\" Leto" Date: Wed, 27 Apr 2011 22:27:57 +0000 Subject: update README --- README | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) (limited to 'README') 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. -- cgit 1.4.1 From e9dfe8b506608610ad801ee6684b6f34067ee504 Mon Sep 17 00:00:00 2001 From: "Jonathan \"Duke\" Leto" Date: Wed, 27 Apr 2011 22:28:18 +0000 Subject: tell github our readme is markdown --- README | 48 ------------------------------------------------ README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 48 deletions(-) delete mode 100644 README create mode 100644 README.md (limited to 'README') diff --git a/README b/README deleted file mode 100644 index 7e3f4d0..0000000 --- a/README +++ /dev/null @@ -1,48 +0,0 @@ -## Jitterbug : Cross Language Continuous integration for Git - - -### What is Jitterbug? - -Jitterbug is written in Perl 5 and depends on various CPAN modules, such -as Moose, Dancer, DBIx::Class and others. - -### Installing Jitterbug - -perl Build.PL - -# You can also use Makefile.PL, but you will then have to manually -# install dependencies -# perl Makefile.PL - - # 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 - - # 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 - -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. - - http://example.com:3001/hook/ - -Now you must start the builder, which actually clones a new git repo for -each task (this could be network-intensive) and actually runs the build -and test commands for each project. - - perl scripts/builder.pl -c config.yml - -Now, when you commit to a project that has a Jitterbug post-receive hook, -the builder check every 30 seconds for a new task and build and test your -projects! - diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e3f4d0 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +## Jitterbug : Cross Language Continuous integration for Git + + +### What is Jitterbug? + +Jitterbug is written in Perl 5 and depends on various CPAN modules, such +as Moose, Dancer, DBIx::Class and others. + +### Installing Jitterbug + +perl Build.PL + +# You can also use Makefile.PL, but you will then have to manually +# install dependencies +# perl Makefile.PL + + # 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 + + # 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 + +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. + + http://example.com:3001/hook/ + +Now you must start the builder, which actually clones a new git repo for +each task (this could be network-intensive) and actually runs the build +and test commands for each project. + + perl scripts/builder.pl -c config.yml + +Now, when you commit to a project that has a Jitterbug post-receive hook, +the builder check every 30 seconds for a new task and build and test your +projects! + -- cgit 1.4.1