diff README.md @ 0:c6b5eb8fe16b draft

"planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit aa4a7f87d556b5af582d1ab8fe9a986922a59a1d"
author genouest
date Tue, 05 Oct 2021 12:35:07 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Tue Oct 05 12:35:07 2021 +0000
@@ -0,0 +1,21 @@
+# Braker
+
+This tool is not in IUC because of the license issues with GeneMark and ProtHint that makes it impossible to test it using CI.
+
+## GeneMark
+
+Braker can use GeneMark to predict gene, but due to licensing issues, we are not allowed to distribute GeneMark automatically.
+
+If you want to use it, the Galaxy administrator needs to install GeneMark, and set the `GENEMARK_PATH` variable on the job destination.
+
+## ProtHint
+
+Braker can use ProtHint to use protein sequences as hints to predict genes, but due to licensing issues, we are not allowed to distribute ProtHint automatically.
+
+If you want to use it, the Galaxy administrator needs to install ProtHint, and set the `PROTHINT_PATH` variable on the job destination.
+
+## Running tests
+
+Tests require working GeneMark and ProtHint installations, which means both GENEMARK_PATH and PROTHINT_PATH are set.
+
+You should also copy a valid GeneMark license (from http://topaz.gatech.edu/GeneMark/license_download.cgi) in test-data/genemark_license.gm_key