Please, Github, use README.textile.

This commit is contained in:
Kornelius Kalnbach 2011-08-19 04:15:07 +02:00
parent 359ae3472c
commit ca3f7c84d4
5 changed files with 26 additions and 12 deletions

20
.gitignore vendored
View File

@ -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

View File

@ -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/] :-)

View File

@ -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

View File

@ -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

View File

@ -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