diff README.rst @ 15:6c751c59ce18 draft

Docker support and update for protk 1.4

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Thu Mar 26 20:04:30 2015 -0400
@@ -0,0 +1,43 @@
+MS-GF+
+======
+
+Galaxy wrapper for the `MS-GF+`__ tandem ms search tool
+
+.. _msgfplus: http://proteomics.ucsd.edu/software-tools/ms-gf/
+__ msgfplus_
+
+Requirements
+------------
+
+This package uses protk_, msgfplus_ and the `idconvert` tool from Proteowizard_ which need to be present in order for the tool to work.
+
+.. _protk: https://github.com/iracooke/protk
+.. _Proteowizard: http://proteowizard.sourceforge.net/
+
+
+There are two ways you can satify these dependencies (choose one):
+
+1. **Manual Install:** Details on how to install protk_, msgfplus_ and Proteowizard_ manually are available here_.
+
+2. **Use Docker:** These tools are designed to run inside a docker_ container. If your galaxy supports `running tools within a docker container`__ you don't need to worry about dependencies. Simply install and things should just work.  The docker container itself is versioned and new versions of this tool will automatically download an update to the container if needed.
+
+.. _docker: https://www.docker.com/
+.. _here: https://github.com/iracooke/protk/#galaxy-integration
+.. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
+__ container_
+
+
+Further Info
+------------
+
+The source code for this tool and other protk galaxy tools is on github_.  Please visit the github page to contribute to the project or to `report an issue`__ 
+
+.. _github: https://github.com/iracooke/protk-galaxytools
+.. _issue: https://github.com/iracooke/protk-galaxytools/issues
+__ issue_
+
+
+Information on the MS-GF+ search tool itself can be found here_
+
+.. _here: http://proteowizard.sourceforge.net/
+