diff --git a/README.md b/README.md index c029e40d3a407676b1e17a045941ec978982db99..4aa5f2d4a6df0383f4951145f75ac55ead86cf70 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/