Better gemspec. Moving to README.rdoc. Trying to add some documentation but need help. More to come.

Author: metaskills

2000-2005-adapter.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
     "CHANGELOG", 
     "MIT-LICENSE", 
     "Rakefile", 
-    "README.textile", 
+    "README.rdoc", 
     "RUNNING_UNIT_TESTS", 
     "autotest",
     "autotest/discover.rb",
@@ -41,6 +41,6 @@ Gem::Specification.new do |s|
     "test/connections/native_sqlserver_odbc/connection.rb",
     "test/migrations/transaction_table/1_table_will_never_be_created.rb",
     "test/schema/sqlserver_specific_schema.rb" ]
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--main", "README.textile"]
-  s.extra_rdoc_files = ["README.textile"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--main", "README.rdoc"]
+  s.extra_rdoc_files = ["README.rdoc"]
 end

README.rdoc

@@ -0,0 +1,39 @@
+
+== Rails SQL Server 2000 & 2005 Adapter
+
+For Rails/ActiveRecord 2.2 and up. More details to come.
+
+
+== Installation
+  
+This method is unconfirmed. You can install the adapter as a gem using the following command. Once I confirm this I can give you an example of a config.gem command too. For now I know that rails and/or ActiveRecord expects to find the SQL Server adapter in the vendor/plugins/adapters/sqlserver folder of your rails project.
+
+  $ sudo gem install rails-sqlserver-2000-2005-adapter
+
+Ruby DBI is required and to my knowledge the ADO DBD driver is no longer supported, meaning that ODBC is the only way to go. During development ancient versions of DBI back to 0.0.23 were tested along with the current latest 0.4.0 version. Because later versions of DBI will be changing many things, IT IS HIGHLY RECOMMENDED that you install 0.4.0 which the examples below show. This is not a compressive how to since ODBC mode requires also that you install Ruby ODBC and possibly FreeTDS.
+
+  $ sudo gem install dbi --version 0.4.0
+  $ sudo gem install dbd-odbc --version 0.2.4
+
+Optionally configure your gem dependencies in your rails environment.rb file.
+
+  config.gem 'dbi', :version => '0.4.0'
+  config.gem 'dbd-odbc', :version => '0.2.4', :lib => 'dbd/ODBC'
+
+
+== Contributing
+
+Please read the RUNNING_UNIT_TESTS file for the details of how to run the unit tests. Bugs can be reported to our lighthouse page at http://rails-sqlserver.lighthouseapp.com/projects/20277-sql-server-05-adapter/overview
+
+There is also a #rails-sqlserver channel on irc.freenode.net if you want to discuss any topics about the adapter.
+
+
+== Credits
+
+Many many people have contributed to this over 
+
+
+== License
+
+Copyright © 2008. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+

README.textile

@@ -108,48 +108,39 @@ def simplified_datetime
 
     end #SQLServerColumn
 
-    # In ADO mode, this adapter will ONLY work on Windows systems,
-    # since it relies on Win32OLE, which, to my knowledge, is only
-    # available on Windows.
+    # In ADO mode, this adapter will ONLY work on Windows systems, since it relies on 
+    # Win32OLE, which, to my knowledge, is only available on Windows.
     #
     # This mode also relies on the ADO support in the DBI module. If you are using the
-    # one-click installer of Ruby, then you already have DBI installed, but
-    # the ADO module is *NOT* installed. You will need to get the latest
-    # source distribution of Ruby-DBI from http://ruby-dbi.sourceforge.net/
-    # unzip it, and copy the file
-    # <tt>src/lib/dbd_ado/ADO.rb</tt>
-    # to
-    # <tt>X:/Ruby/lib/ruby/site_ruby/1.8/DBD/ADO/ADO.rb</tt>
-    # (you will more than likely need to create the ADO directory).
-    # Once you've installed that file, you are ready to go.
-    #
+    # one-click installer of Ruby, then you already have DBI installed, but the ADO module 
+    # is *NOT* installed. You will need to get the latest source distribution of Ruby-DBI 
+    # from http://ruby-dbi.sourceforge.net/ unzip it, and copy the file from 
+    # <tt>src/lib/dbd_ado/ADO.rb</tt> to <tt>X:/Ruby/lib/ruby/site_ruby/1.8/DBD/ADO/ADO.rb</tt>
+    # 
+    # You will more than likely need to create the ADO directory. Once you've installed 
+    # that file, you are ready to go.
+    # 
     # In ODBC mode, the adapter requires the ODBC support in the DBI module which requires
-    # the Ruby ODBC module.  Ruby ODBC 0.996 was used in development and testing,
+    # the Ruby ODBC module. Ruby ODBC 0.996 was used in development and testing,
     # and it is available at http://www.ch-werner.de/rubyodbc/
     #
     # Options:
     #
-    # * <tt>:mode</tt>      -- ADO or ODBC. Defaults to ADO.
-    # * <tt>:username</tt>  -- Defaults to sa.
-    # * <tt>:password</tt>  -- Defaults to empty string.
-    # * <tt>:windows_auth</tt> -- Defaults to "User ID=#{username};Password=#{password}"
+    # * <tt>:mode</tt>          -- ADO or ODBC. Defaults to ADO.
+    # * <tt>:username</tt>      -- Defaults to sa.
+    # * <tt>:password</tt>      -- Defaults to empty string.
+    # * <tt>:windows_auth</tt>  -- Defaults to "User ID=#{username};Password=#{password}"
     #
     # ADO specific options:
     #
-    # * <tt>:host</tt>      -- Defaults to localhost.
-    # * <tt>:database</tt>  -- The name of the database. No default, must be provided.
-    # * <tt>:windows_auth</tt> -- Use windows authentication instead of username/password.
+    # * <tt>:host</tt>          -- Defaults to localhost.
+    # * <tt>:database</tt>      -- The name of the database. No default, must be provided.
+    # * <tt>:windows_auth</tt>  -- Use windows authentication instead of username/password.
     #
     # ODBC specific options:
     #
-    # * <tt>:dsn</tt>       -- Defaults to nothing.
-    #
-    # ADO code tested on Windows 2000 and higher systems,
-    # running ruby 1.8.2 (2004-07-29) [i386-mswin32], and SQL Server 2000 SP3.
-    #
-    # ODBC code tested on a Fedora Core 4 system, running FreeTDS 0.63,
-    # unixODBC 2.2.11, Ruby ODBC 0.996, Ruby DBI 0.0.23 and Ruby 1.8.2.
-    # [Linux strongmad 2.6.11-1.1369_FC4 #1 Thu Jun 2 22:55:56 EDT 2005 i686 i686 i386 GNU/Linux]
+    # * <tt>:dsn</tt>           -- Defaults to nothing.
+    # 
     class SQLServerAdapter < AbstractAdapter
 
       ADAPTER_NAME            = 'SQLServer'.freeze