updated readme and example.config

cruise-control/README

@@ -1,27 +1,24 @@
 A simple regular testing of Moses codebase, aka cruise control
-Started by Ondrej Bojar
-2011-08-28
+--------------------------------------------------------------
+
+Features:
+
+- Checkout latest commits
+- Test configure, make, make scripts
+- Run regression tests
+- Run a sample EMS pipeline
+- Report results into logfiles
+
+How to run cruise control:
+
+1) Download and compile SRILM
+
+2) Download, compile and install IRSTLM
+
+3) Edit the configuration file example.config. You can create as many
+   configuration files as you like.
+
+4) Execute ./test_all_new_commits.sh yourfile.config
 
 
-Usage:
-
-1. Checkout this directory somewhere on the computer where you want to run the
-   cruise control.
-2. Create as many config files as you wish, an example is ondrej-nb.config
-   ...hardcode all paths to you preferred external tools like LM toolkits.
-3. Run ./test_all_new_commits.sh <CONFIGFILE>
-
-
-
-TODO / KNOWN BUGS
-- regression tests are not run yet
-
-- regression tests always require SRILM, but we need to test all LMs that have
-  been compiled in
-  => add separate regression tests, one for each LM?
-  => modify regression tests to actually loop over all LMs?
-
-- final status is FAIL if any regression test fails, but we should actually
-  allow to expect failures for the given set of ./configure parameters
-  (e.g. regression test requiring irstlm is bound to fail if we're not linking
-  against irstlm)
+Written by Ondrej Bojar, Ales Tamchyna, Barry Haddow, Rimas Blazaitis

cruise-control/example.config

@@ -2,20 +2,20 @@
 MCC_TEMPDIR="/tmp/"
 
 # where logs are saved
-MCC_LOGDIR="/home/ales/mtm6/moses/cruise-control/"
+MCC_LOGDIR="/home/cruise/"
 
 # where moses gets checked out, tested etc.
-MCC_WORKDIR="/home/ales/mtm6/moses/cruise-control/work/"
+MCC_WORKDIR="/home/cruise/work/"
 
-# repository that will be checked out, must be a local directory (for now?)
-MCC_GITREPO="git://mosesdecoder.git.sourceforge.net/gitroot/mosesdecoder/mosesdecoder"
+# repository that will be checked out
+MCC_GITREPO="https://github.com/moses-smt/mosesdecoder.git"
 
 # arguments passed to Moses configure
-MCC_CONFIGURE_ARGS=" --with-srilm=/home/ales/mtm6/srilm/ "
+MCC_CONFIGURE_ARGS=" --with-srilm=/path/to/srilm --with-irstlm=/path/to/irstlm "
 
 # list of branches to be checked
 MCC_SCAN_BRANCHES="master"
 
-# regression test data archive
-MCC_REGTEST_ARCHIVE="http://www.statmt.org/moses/reg-testing/moses-reg-test-data-7.tgz"
+# regression test data archive (optional, this is the default)
+MCC_REGTEST_ARCHIVE="http://www.statmt.org/moses/reg-testing/moses-reg-test-data-8.tgz"