From 056db339066c6b566b4cfab0a30845d3f72cbc3e Mon Sep 17 00:00:00 2001 From: Jamis Buck Date: Fri, 30 May 2008 13:20:37 -0600 Subject: rename README to README.rdoc. Also update the Rakefile and gemspecs to reference the new CHANGELOG.rdoc README.rdoc. --- README | 51 ---------------------------------------------- README.rdoc | 51 ++++++++++++++++++++++++++++++++++++++++++++++ Rakefile | 19 ++++++----------- sqlite3-ruby-win32.gemspec | 7 +++---- sqlite3-ruby.gemspec | 7 +++---- 5 files changed, 63 insertions(+), 72 deletions(-) delete mode 100644 README create mode 100644 README.rdoc diff --git a/README b/README deleted file mode 100644 index 5b8eece..0000000 --- a/README +++ /dev/null @@ -1,51 +0,0 @@ -= SQLite3/Ruby Interface - -This module allows Ruby programs to interface with the SQLite3 -database engine (http://www.sqlite.org). You must have the -SQLite engine installed in order to build this module. - -Note that this module is NOT compatible with SQLite 2.x. - - -== Compilation and Installation - -Simply do the following, after installing SQLite3: - - ruby setup.rb config - ruby setup.rb setup - ruby setup.rb install - -Alternatively, you can download and install the RubyGem package for -SQLite3/Ruby (you must have RubyGems and SQLite3 installed, first): - - gem install sqlite3-ruby - -If you have sqlite3 installed in a non-standard location, you can specify the location of the include and lib files by doing: - - gem install sqlite3-ruby -- --with-sqlite3-include=/opt/local/include \ - --with-sqlite3-lib=/opt/local/lib - -Also, the gem ships with the C source-code pre-built, so (as of version 1.1.1) -you no longer need to have SWIG installed. However, if you have SWIG installed -and you want to generate the C file yourself, you can specify the ---with-swig option. - -== Usage - -For help figuring out the SQLite3/Ruby interface, check out the -FAQ[http://sqlite-ruby.rubyforge.org/sqlite3/faq.html]. It includes examples of -usage. If you have any questions that you feel should be address in the -FAQ, please send them to jamis@37signals.com - -== Source Code - -The source repository is accessible via git: - - git clone git://github.com/jamis/sqlite3-ruby.git - -== Contact Information - -The project page is http://rubyforge.org/projects/sqlite-ruby. There, you can -find links to mailing lists and forums that you can use to discuss this -library. Additionally, there are trackers for submitting bugs and feature -requests. Feel free to use them! diff --git a/README.rdoc b/README.rdoc new file mode 100644 index 0000000..5b8eece --- /dev/null +++ b/README.rdoc @@ -0,0 +1,51 @@ += SQLite3/Ruby Interface + +This module allows Ruby programs to interface with the SQLite3 +database engine (http://www.sqlite.org). You must have the +SQLite engine installed in order to build this module. + +Note that this module is NOT compatible with SQLite 2.x. + + +== Compilation and Installation + +Simply do the following, after installing SQLite3: + + ruby setup.rb config + ruby setup.rb setup + ruby setup.rb install + +Alternatively, you can download and install the RubyGem package for +SQLite3/Ruby (you must have RubyGems and SQLite3 installed, first): + + gem install sqlite3-ruby + +If you have sqlite3 installed in a non-standard location, you can specify the location of the include and lib files by doing: + + gem install sqlite3-ruby -- --with-sqlite3-include=/opt/local/include \ + --with-sqlite3-lib=/opt/local/lib + +Also, the gem ships with the C source-code pre-built, so (as of version 1.1.1) +you no longer need to have SWIG installed. However, if you have SWIG installed +and you want to generate the C file yourself, you can specify the +--with-swig option. + +== Usage + +For help figuring out the SQLite3/Ruby interface, check out the +FAQ[http://sqlite-ruby.rubyforge.org/sqlite3/faq.html]. It includes examples of +usage. If you have any questions that you feel should be address in the +FAQ, please send them to jamis@37signals.com + +== Source Code + +The source repository is accessible via git: + + git clone git://github.com/jamis/sqlite3-ruby.git + +== Contact Information + +The project page is http://rubyforge.org/projects/sqlite-ruby. There, you can +find links to mailing lists and forums that you can use to discuss this +library. Additionally, there are trackers for submitting bugs and feature +requests. Feel free to use them! diff --git a/Rakefile b/Rakefile index 43ddfc2..8eea179 100644 --- a/Rakefile +++ b/Rakefile @@ -23,7 +23,7 @@ PACKAGE_FILES = FileList.new do |fl| [ "api", "doc" ].each do |dir| fl.include "#{dir}/**/*" end - fl.include "ChangeLog", "README", "LICENSE", "#{PACKAGE_NAME}.gemspec", "setup.rb" + fl.include "CHANGELOG.rdoc", "README.rdoc", "LICENSE", "#{PACKAGE_NAME}.gemspec", "setup.rb" fl.include SOURCE_FILES end @@ -41,13 +41,6 @@ end desc "Default task" task :default => [ :test ] -desc "Build the ChangeLog" -task :changelog do - output = `ruby util/svn2cl.rb` - cvs = File.read( "ChangeLog.cvs" ) - File.open( "ChangeLog", "w" ) { |f| f.write output + cvs } -end - desc "Clean generated files" task :clean do rm_rf "ChangeLog" @@ -94,10 +87,10 @@ bz2_file = "#{package_name}.tar.bz2" zip_file = "#{package_name}.zip" gem_file = "#{package_name}.gem" -task :gzip => SOURCE_FILES + [ :changelog, :faq, :rdoc, "#{package_dir}/#{gz_file}" ] -task :bzip => SOURCE_FILES + [ :changelog, :faq, :rdoc, "#{package_dir}/#{bz2_file}" ] -task :zip => SOURCE_FILES + [ :changelog, :faq, :rdoc, "#{package_dir}/#{zip_file}" ] -task :gem => SOURCE_FILES + [ :changelog, :faq, "#{package_dir}/#{gem_file}" ] +task :gzip => SOURCE_FILES + [ :faq, :rdoc, "#{package_dir}/#{gz_file}" ] +task :bzip => SOURCE_FILES + [ :faq, :rdoc, "#{package_dir}/#{bz2_file}" ] +task :zip => SOURCE_FILES + [ :faq, :rdoc, "#{package_dir}/#{zip_file}" ] +task :gem => SOURCE_FILES + [ :faq, "#{package_dir}/#{gem_file}" ] task :package => [ :gzip, :bzip, :zip, :gem ] @@ -148,7 +141,7 @@ end Rake::RDocTask.new do |rdoc| rdoc.rdoc_dir = 'api' rdoc.title = "SQLite3/Ruby" - rdoc.options += %w(--line-numbers --inline-source --main README) + rdoc.options += %w(--line-numbers --inline-source --main README.rdoc) rdoc.rdoc_files.include('lib/**/*.rb') if can_require( "rdoc/generators/template/html/jamis" ) diff --git a/sqlite3-ruby-win32.gemspec b/sqlite3-ruby-win32.gemspec index 7a34ad5..ac44492 100644 --- a/sqlite3-ruby-win32.gemspec +++ b/sqlite3-ruby-win32.gemspec @@ -10,14 +10,13 @@ Gem::Specification.new do |s| s.summary = "SQLite3/Ruby is a module to allow Ruby scripts to interface with a SQLite database." s.files = Dir.glob("{doc,ext,lib,test}/**/*") - s.files.concat [ "LICENSE", "README", "ChangeLog" ] + s.files.concat [ "LICENSE", "README.rdoc", "CHANGELOG.rdoc" ] s.require_path = 'lib' - s.autorequire = 'sqlite3' s.has_rdoc = true - s.extra_rdoc_files = [ "README" ] - s.rdoc_options = [ "--main", "README" ] + s.extra_rdoc_files = [ "README.rdoc" ] + s.rdoc_options = [ "--main", "README.rdoc" ] s.test_suite_file = "test/tests.rb" diff --git a/sqlite3-ruby.gemspec b/sqlite3-ruby.gemspec index 4fe75be..ac8f000 100644 --- a/sqlite3-ruby.gemspec +++ b/sqlite3-ruby.gemspec @@ -10,16 +10,15 @@ Gem::Specification.new do |s| s.summary = "SQLite3/Ruby is a module to allow Ruby scripts to interface with a SQLite3 database." s.files = Dir.glob("{doc,ext,lib,test}/**/*") - s.files.concat [ "LICENSE", "README", "ChangeLog" ] + s.files.concat [ "LICENSE", "README.rdoc", "CHANGELOG.rdoc" ] s.require_path = 'lib' - s.autorequire = 'sqlite3' s.extensions << 'ext/sqlite3_api/extconf.rb' s.has_rdoc = true - s.extra_rdoc_files = [ "README" ] - s.rdoc_options = [ "--main", "README" ] + s.extra_rdoc_files = [ "README.rdoc" ] + s.rdoc_options = [ "--main", "README.rdoc" ] s.test_suite_file = "test/tests.rb" -- cgit