Please, Github, use README.textile.

korny · korny · commit ca3f7c84d4ea · 2011-08-19T04:15:07.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,22 @@
-Gemfile.lock
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
 pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+.rvmrc
+
 test/executable/source.rb.html
 test/executable/source.rb.json
 test/scanners
 bench/test.div.html
-.rvmrc
-diff.html
+diff.html
diff --git a/README_INDEX.rdoc b/README_INDEX.rdoc
@@ -1,7 +1,5 @@
 = CodeRay
 
-http://travis-ci.org/rubychan/coderay.png
-
 Tired of blue'n'gray? Try the original version of this documentation on
 coderay.rubychan.de[http://coderay.rubychan.de/doc/] :-)
 
diff --git a/Rakefile b/Rakefile
@@ -14,7 +14,7 @@ if File.directory? 'rake_tasks'
   
 else
   
-  # fallback tasks when rake_tasks folder is not present
+  # fallback tasks when rake_tasks folder is not present (eg. in the distribution package)
   desc 'Run CodeRay tests (basic)'
   task :test do
     ruby './test/functional/suite.rb'
@@ -26,9 +26,9 @@ else
   desc 'Generate documentation for CodeRay'
   Rake::RDocTask.new :doc do |rd|
     rd.title = 'CodeRay Documentation'
-    rd.main = 'README.rdoc'
+    rd.main = 'README_INDEX.rdoc'
     rd.rdoc_files.add Dir['lib']
-    rd.rdoc_files.add 'README.rdoc'
+    rd.rdoc_files.add rd.main
     rd.rdoc_dir = 'doc'
   end
   
diff --git a/coderay.gemspec b/coderay.gemspec
@@ -28,12 +28,14 @@ Gem::Specification.new do |s|
   # s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   # s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   # s.require_paths = ["lib"]
-  s.files         = Dir['lib/**/*.rb'] + %w(Rakefile README.rdoc LICENSE) + Dir['test/functional/*.rb']
+  readme_file = 'README_INDEX.rdoc'
+  
+  s.files         = Dir['lib/**/*.rb'] + %W(Rakefile #{readme_file} LICENSE) + Dir['test/functional/*.rb']
   s.test_files    = Dir['test/functional/*.rb']
   s.executables   = ['coderay']
   s.require_paths = ['lib']
   
   s.rubyforge_project = s.name
-  s.rdoc_options      = '-SNw2', '-mREADME.rdoc', '-t CodeRay Documentation'
-  s.extra_rdoc_files  = 'README.rdoc'
+  s.rdoc_options      = '-SNw2', "-m#{readme_file}", '-t CodeRay Documentation'
+  s.extra_rdoc_files  = readme_file
 end
diff --git a/rake_tasks/documentation.rake b/rake_tasks/documentation.rake
@@ -20,7 +20,7 @@ Rake::RDocTask.new :doc do |rd|
   template = File.join ROOT, 'rake_helpers', 'coderay_rdoc_template.rb'
   rd.template = Pathname.new(template).expand_path.to_s
   
-  rd.rdoc_files.add 'README.rdoc'
+  rd.rdoc_files.add 'README_INDEX.rdoc'
   rd.rdoc_files.add Dir['lib']
   rd.rdoc_dir = 'doc'
 end if defined? Rake::RDocTask
