index.html in echi-converter-0.3.0

- old
+ new

@@ -31,11 +31,11 @@
 <div id="main">
 
     <h1>ECHI Converter</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/echi-converter"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.2.1</a>
+      <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.3.0</a>
     </div>
     <h1>&#x2192; &#8216;echi-converter&#8217;</h1>
 
 
 	<h2>The <span class="caps">ECHI</span> (External Call History Interface) Converter</h2>
@@ -61,10 +61,11 @@
 		<li>Generate your schema via ActiveRecord Migrations</li>
 		<li>Fetch Binary or <span class="caps">ASCII CSV</span> files from the Avaya <span class="caps">CMS</span> platform via <span class="caps">FTP</span></li>
 		<li>Convert from the defined Binary format to <span class="caps">ASCII</span></li>
 		<li>Insert the records into the defined database table using database transactions, via ActiveRecord, on a per file basis to support recovery on failure</li>
 		<li>Change schema structure via <span class="caps">YML</span> configuration file to accommodate various releases of the <span class="caps">ECHI</span> format</li>
+		<li>Runs as a daemon (via fork) on *NIX and a service on Windows</li>
 	</ol>
 
 
 	<ol>
 	<li>Table names:
@@ -83,11 +84,12 @@
 		<li><a href="http://www.rubygems.org/">Rubygems v0.9.4+</a></li>
 		<li><a href="http://activerecord.rubyforge.org/">ActiveRecord v1.15.3+</a></li>
 		<li><a href="http://activesupport.rubyforge.org/">ActiveSupport v1.4.2+</a></li>
 		<li><a href="http://daemons.rubyforge.org/">Daemons v1.0.7+</a></li>
 		<li><a href="http://fastercsv.rubyforge.org/">FasterCSV v1.2.0+</a></li>
-		<li><a href="http://rake.rubyforge.org/">Rake v0.7.3+</a></li>
+		<li><a href="http://rake.rubyforge.org/">Rake v0.7.3+</a>
+    # <a href="http://win32utils.rubyforge.org/">Win32-service v.0.5.2+</a> (Manual install for Windows only)</li>
 		<li><a href="http://rubyforge.org/projects/seattlerb/">Hoe v1.2.2+</a></li>
 	</ol>
 
 
 	<h2>Installing</h2>
@@ -141,19 +143,36 @@
 	<li>echi-converter create myproject &#8211; create the local project to run the <span class="caps">ECHI</span> converter from</li>
 		<li>echi-converter upgrade myproject &#8211; location of project to upgrade after a new gem is installed</li>
 	</ol>
 
 
+	<p>For *NIX:</p>
+
+
 	<ol>
 	<li>echi-converter run myproject &#8211; Run the <span class="caps">ECHI</span> converter interactively from the location given</li>
 		<li>echi-converter start myproject &#8211; Start the <span class="caps">ECHI</span> converter in daemon mode from the location given</li>
 		<li>echi-converter stop myproject &#8211; Stop the <span class="caps">ECHI</span> converter daemon</li>
 		<li>echi-converter restart myproject &#8211; Restart the <span class="caps">ECHI</span> converter </li>
 		<li>echi-converter zap myrpoject &#8211; If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files</li>
 	</ol>
 
 
+	<p>For Windows:</p>
+
+
+	<ol>
+	<li>echi-converter install myproject &#8211; install the service (must specify complete path such as c:\path\to\my\project )</li>
+		<li>echi-converter start &#8211; start the service</li>
+		<li>echi-converter stop &#8211; stop the service</li>
+		<li>echi-converter pause &#8211; pause the service</li>
+		<li>echi-converter resume &#8211; resume the service</li>
+		<li>echi-converter uninstall &#8211; uninstall the service</li>
+		<li>echi-converter delete &#8211; delete the service&#8221;</li>
+	</ol>
+
+
 	<h2>Demonstration of usage</h2>
 
 
 	<p>Start the daemon/service:</p>
 
@@ -163,18 +182,22 @@
 	<p>Stop the daemon/service:</p>
 
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
-	<h2>ToDo</h2>
+	<h2>Limitations</h2>
 
 
 	<p>Items to be done to move this out of alpha stage:</p>
 
 
 	<ol>
-	<li>&#8216;echi-converter create&#8217; works fine with <span class="caps">OSX</span>/Linux, need to test validate with a Win32 platform, therefore currently recommended to only run on a Linux/OSX platform, could use <a href="http://www.vmware.com">VMWare</a> to do this on Windows.</li>
+	<li>There are currently two limitations when running on Windows
+	<ol>
+	<li>Project directories may not have spaces</li>
+		<li>The Ruby interpreter must be installed in the default location of c:\ruby\bin</li>
+	</ol></li>
 	</ol>
 
 
 	<h2>Screencast</h2>
 
@@ -206,10 +229,10 @@
 	<h2>Contact</h2>
 
 
 	<p>Comments are welcome. Send an email to <a href="mailto:jason@goecke.net">jason [at] goecke.net</a>.</p>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 26th October 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 2nd November 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>
 
 <!-- insert site tracking codes here, like Google Urchin -->