diff readme.rst @ 2:d03a63a57e82 draft

New version, better following configuration guidelines
author geert-vandeweyer
date Wed, 19 Feb 2014 06:45:32 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/readme.rst	Wed Feb 19 06:45:32 2014 -0500
@@ -0,0 +1,17 @@
+Galaxy wrapper for VariantDB Import
+===================================
+
+This wrapper and VariantDB is written by Geert Vandeweyer. 
+
+The recommended installation is by means of the toolshed_.
+
+.. _toolshed: http://toolshed.g2.bx.psu.edu/view/geert-vandeweyer/vcf_to_variantdb
+
+Galaxy should be able to install the needed perl module dependencies automatically
+for you. To allow your server to communicate with VariantDB, you must edit the GALAXY_URL environment variable in the file:
+
+<tool_dependency_dir>/environment_settings/GALAXY_URL/geert-vandeweyer/vcf_to_variantdb/<hash_string>/env.sh
+
+to point to the full URL of the server (e.g: http://biominavm-galaxy.biomina.be/galaxy ) where you have installed the wrapper.
+
+Finally, if you also have a private VariantDB instance, you need to add it to the wrapper configuration file, as an extra option.