diff README.md @ 8:d2c61663e33c draft

Uploaded
author galaxyp
date Fri, 26 Sep 2014 14:44:54 -0400
parents 10f4a0356342
children dd4ba10d0c45
line wrap: on
line diff
--- a/README.md	Mon Feb 17 17:00:29 2014 -0500
+++ b/README.md	Fri Sep 26 14:44:54 2014 -0400
@@ -1,47 +1,67 @@
-# msconvert
+GalaxyP - ProteoWizard msconvert
+================================
+
+* Home: <https://bitbucket.org/galaxyp/msconvert>
+* Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/msconvert>
+* Tool ID: `msconvert`
+
 
-This repository contains Galaxy tool wrappers for msconvert, part of
-the ProteoWizard (http://proteowizard.sourceforge.net/) package.
+Description
+-----------
 
-# Installing
+msconvert from ProteoWizard.
+
+Note: This requires manual installation of ProteoWizard, and may require a Windows environment.
+
+See:
 
-Due to potential difficulties installing ProteoWizard with vendor
-library support, tools for interacting with vendor types are seperated
-out into their own wrappers. Galaxy is generally deployed under Linux,
-but vendor support in ProteoWizard requires .NET 4.0. There are at
-least two ways to get this to work:
+* <http://proteowizard.sourceforge.net/>
+* <http://proteowizard.sourceforge.net/tools/msconvert.html>
+
+
+Installing
+----------
 
-  * Galaxy jobs may be configured to submit to a Windows host with
-    ProteoWizard installed using the
-    LWR. http://wiki.g2.bx.psu.edu/Admin/Config/LWR
+Due to potential difficulties installing ProteoWizard with vendor library support, tools for interacting with vendor types are seperated out into their own wrappers. Galaxy is generally deployed under Linux, but vendor support in ProteoWizard requires .NET 4.0. There are at least two ways to get this to work:
+
+* Galaxy jobs may be configured to submit to a Windows host with ProteoWizard installed using the [LWR](https://wiki.g2.bx.psu.edu/Admin/Config/LWR).
 
-  * ProteoWizard can be installed under Wine. Guidance on how to set
-    this up and package such environments for cloud deployments can be
-    found here: https://github.com/jmchilton/proteomics-wine-env
+* ProteoWizard can be installed under Wine. Guidance on how to set this up and package such environments for cloud deployments can be found here: <https://github.com/jmchilton/proteomics-wine-env>
+
+
+GalaxyP Community
+-----------------
 
-Wrappers for both msconvert version 2 and version 3+ are provided
-because version 3+ of msconvert with vendor library support requires
-.NET 4.0 and this may difficult or impossible under Wine in Linux with
-all but the most recent versions of Wine (1.4+).
-# Obtaining Tools
+Current governing community policies for [GalaxyP](https://bitbucket.org/galaxyp/) and other information can be found at:
+
+<https://bitbucket.org/galaxyp/galaxyp>
+
+
+License
+-------
 
-Repositories for all Galaxy-P tools can be found at
-https:/bitbucket.org/galaxyp/.
+Copyright (c) 2014 Regents of the University of Minnesota and Authors listed below.
+
+To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
 
-# Contact
+You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <https://creativecommons.org/publicdomain/zero/1.0/>.
+
+You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
+
 
-Please send suggestions for improvements and bug reports to
-jmchilton@gmail.com.
+Contributing
+------------
 
-# License
+Contributions to this repository are reviewed through pull requests. If you would like your work acknowledged, please also add yourself to the Authors section. If your pull request is accepted, you will also be acknowledged in <https://bitbucket.org/galaxyp/galaxyp/CONTRIBUTORS.md> unless you opt-out.
 
-All Galaxy-P tools are licensed under the Apache License Version 2.0
-unless otherwise documented.
 
-# Tool Versioning
+Authors
+-------
+
+Authors and contributors:
 
-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.
+* Björn Grüning
+* Cody Wang
+* Fred Sadler
+* John Chilton <jmchilton@gmail.com>
+* Minnesota Supercomputing Institute, Univeristy of Minnesota