[Swift-commit] r7707 - SwiftApps/swift-galaxy

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2014-03-13 11:34:39 -0500 (Thu, 13 Mar 2014)
New Revision: 7707

Modified:
   SwiftApps/swift-galaxy/README
Log:
doc updates

Modified: SwiftApps/swift-galaxy/README
===================================================================
--- SwiftApps/swift-galaxy/README	2014-03-13 16:20:30 UTC (rev 7706)
+++ SwiftApps/swift-galaxy/README	2014-03-13 16:34:39 UTC (rev 7707)
@@ -37,9 +37,15 @@
 place over a list of items provided as a file.
 
 
-How To
-------
+Installation
+-------------
 
+Step 0. Checkout the swift-galaxy tools directory as follows:
+
+----
+svn co https://svn.ci.uchicago.edu/svn/vdl2/SwiftApps/swift-galaxy
+----
+
 Step 1. Symlink the swift directory in the current directory from galaxy's top
 level directory. For example, if Galaxy top level directory is galaxy-dist and
 swift directory is /home/ketan/SwiftApps/swift-galaxy/swift:
@@ -49,11 +55,23 @@
 ln -s /home/ketan/SwiftApps/swift-galaxy/swift swift
 ----
 
+The advantage of symbolic links is that as users update the tool directory via
+`svn up`, they need not worry about reinstallation. Everything gets propagated
+to Galaxy.
+
 Step 2. Add the tool definitions of the tools contained in this Swift to
 Galaxy's tool_conf.xml. This can be done by copying the text in
 `<section>...</section>` from the tool_conf.xml in swift-galaxy directory and
-paste it to the tool_conf.xml of the Galaxy directory.
+paste it to the tool_conf.xml of the Galaxy directory. In the current installation, the text to be copied is:
 
+----
+<section name="swift" id="swift">
+ <tool file="swift/genswift.xml" />
+ <tool file="swift/genericswift.xml" />
+ <tool file="swift/swiftforeach.xml" />
+</section>
+----
+
 Step 3. (Re)start Galaxy.
 
 ----