summaryrefslogtreecommitdiff
path: root/rdoc/files/README_rdoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'rdoc/files/README_rdoc.html')
-rw-r--r--rdoc/files/README_rdoc.html140
1 files changed, 140 insertions, 0 deletions
diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html
new file mode 100644
index 0000000..3342971
--- /dev/null
+++ b/rdoc/files/README_rdoc.html
@@ -0,0 +1,140 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>File: README.rdoc</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="fileHeader">
+ <h1>README.rdoc</h1>
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Path:</strong></td>
+ <td>README.rdoc
+ </td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>Last Update:</strong></td>
+ <td>Thu Aug 13 11:00:51 +0200 2009</td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <h1>opentox-ruby-api-wrapper</h1>
+<p>
+Ruby wrapper for the <a href="../classes/OpenTox.html">OpenTox</a> REST API
+(<a href="http://www.opentox.org">www.opentox.org</a>)
+</p>
+<h2>Installation</h2>
+<p>
+Run the following if you haven&#8216;t already:
+</p>
+<pre>
+ gem sources -a http://gems.github.com
+</pre>
+<p>
+Install the gem:
+</p>
+<pre>
+ sudo gem install helma-opentox-ruby-api-wrapper
+</pre>
+<h2>Usage</h2>
+<ul>
+<li>set the environment variables OPENTOX_COMPOUNDS, OPENTOX_FEATURES,
+OPENTOX_DATASETS, OPENTOX_FMINER to the base URI of the <a
+href="../classes/OpenTox.html">OpenTox</a> REST webservices
+
+</li>
+<li>require &#8216;opentox-ruby-api-wrapper&#8217; in your ruby application
+
+</li>
+<li>consult the API documentation for details
+
+</li>
+</ul>
+<h2>Copyright</h2>
+<p>
+Copyright (c) 2009 Christoph Helma. See LICENSE for details.
+</p>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html> \ No newline at end of file