From b5dfe48a3c9f908adceb047775d780c0ba67d6a6 Mon Sep 17 00:00:00 2001 From: Martin Czygan <martin.czygan@gmail.com> Date: Wed, 26 Nov 2014 18:25:07 +0100 Subject: [PATCH] Add testing notes to README. A combined, slightly modified version of the changes to README.md from: * eac50fc 2014-11-03 | added dev-dependencies to add ci-tools via composer [Ulf Seltmann] * 12e3f23 2014-10-14 | * reverted vendor to vufind.org state * added composer.phar * updated all dependencies from composer.json [Ulf Seltmann] * 729ff5e 2014-09-11 | modified docu [smoebody] --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c029e40d3a4..4aa5f2d4a6d 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,37 @@ Introduction VuFind is an open source discovery environment for searching a collection of records. To learn more, visit http://vufind.org. - Installation ------------ -See online documentation at http://vufind.org/wiki/vufind2:installation_notes \ No newline at end of file +See online documentation at http://vufind.org/wiki/vufind2:installation_notes + +Testing +------- + +For performing all ci-tasks you have to add all dev-dependencies. Do so like this + + php composer.phar update + +this adds all necessary tools like phing, phpunit, etc. + +After that you can perform the task with the following command: + + phing + +Be aware that you will need several programs like java and mysql to setup a solr-index and a database-store in order to +test the components of vufind that communicate with them. + +You might need to set up the mysql-user credentials, if case they do not agree with your mysql root-users credentials. +You can do that by providing optional parameters like that + + phing -Dmysqlrootpass='' + +Do so if you have no rootpassword set. The default password is 'password'. + +Modules +------- + +* all non-global non-community modules go to + + module/finc/ -- GitLab