diff README.md @ 0:59e5d8c53c81 draft

Uploaded
author galaxyp
date Wed, 19 Dec 2012 00:27:24 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Wed Dec 19 00:27:24 2012 -0500
@@ -0,0 +1,44 @@
+# ms2preproc
+
+This repository contains a tool wrapper for ms2preproc.
+
+http://hci.iwr.uni-heidelberg.de/MIP/Software/ms2preproc.php
+
+This tool requires Galaxy to be equipped with common proteomic
+datatypes. These can be obtained by installing Ira Cooke's ProtK via
+the tool shed or merging the changesets from the following repository
+into your Galaxy instance:
+
+     https://bitbucket.org/galaxyp/galaxy-dist-proteomics
+
+# Installing
+
+This tool wrapper requires ms2preproc to be installed. 
+
+For Galaxy-P we are installing this tool via CloudBioLinux
+(https://github.com/jmchilton/cloudbiolinux/blob/proteomics/cloudbio/custom/bio_proteomics.py). While
+this fabric script may not be exactly appropriate for your environment
+it may serve as a template for how to install this software.
+
+# Obtaining Tools
+
+Repositories for all Galaxy-P tools can be found at
+https:/bitbucket.org/galaxyp/.
+
+# Contact
+
+Please send suggestions for improvements and bug reports to
+jmchilton@gmail.com.
+
+# License
+
+All Galaxy-P tools are licensed under the Apache License Version 2.0
+unless otherwise documented.
+
+# Tool Versioning
+
+Galaxy-P tools will have versions of the form X.Y.Z. Versions
+differing only after the second decimal should be completely
+compatible with each other. Breaking changes should result in an
+increment of the number before and/or after the first decimal. All
+tools of version less than 1.0.0 should be considered beta.