diff README.rst @ 1:354e820eb485 draft

Docker support and update for protk 1.4
author iracooke
date Thu, 26 Mar 2015 21:27:53 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Thu Mar 26 21:27:53 2015 -0400
@@ -0,0 +1,33 @@
+Make Decoys
+===========
+
+Create decoy sequences for tandem ms searching
+
+Requirements
+------------
+
+This package uses protk_ which needs to be present in order for the tool to work.
+
+.. _protk: https://github.com/iracooke/protk
+
+There are two ways you can satify this dependency (choose one):
+
+1. **Manual Install:** Details on how to install protk_ manually are available here_.
+
+2. **Use Docker:** This tool is 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_
+