From 20677629859128b2fd3620ec5575a9b0c2611cf1 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Tue, 27 Jul 2010 17:15:49 +0300 Subject: [PATCH] small changes to project dev files --- .gitignore | 1 + LICENSE | 4 +++- README.md | 38 ++++++++++++++++++++++++++++++++++++++ README.rdoc | 17 ----------------- Rakefile | 16 ++++++++-------- spec/spec.opts | 1 + 6 files changed, 51 insertions(+), 26 deletions(-) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/.gitignore b/.gitignore index c1e0daf..5d48d42 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ rdoc pkg ## PROJECT::SPECIFIC +.yardoc/* diff --git a/LICENSE b/LICENSE index f04e49f..60f266b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,6 @@ -Copyright (c) 2009 Jim Myhrberg +(The MIT License) + +Copyright (c) 2010 Jim Myhrberg. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.md b/README.md new file mode 100644 index 0000000..570c31d --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# time_ext + +Description goes here. + +## Note on Patches/Pull Requests + +* Fork the project. +* Make your feature addition or bug fix. +* Add tests for it. This is important so I don't break it in a + future version unintentionally. +* Commit, do not mess with rakefile, version, or history. + (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) +* Send me a pull request. Bonus points for topic branches. + +## Copyright + +(The MIT License) + +Copyright (c) 2010 Jim Myhrberg. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index d7833f8..0000000 --- a/README.rdoc +++ /dev/null @@ -1,17 +0,0 @@ -= time_ext - -Description goes here. - -== Note on Patches/Pull Requests - -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. - -== Copyright - -Copyright (c) 2010 Jim Myhrberg. See LICENSE for details. diff --git a/Rakefile b/Rakefile index e48a5c6..890e1aa 100644 --- a/Rakefile +++ b/Rakefile @@ -11,6 +11,7 @@ begin gem.homepage = "http://github.com/jimeh/time_ext" gem.authors = ["Jim Myhrberg"] gem.add_development_dependency "rspec", ">= 1.2.9" + gem.add_development_dependency "yard", ">= 0" # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings end Jeweler::GemcutterTasks.new @@ -34,12 +35,11 @@ task :spec => :check_dependencies task :default => :spec -require 'rake/rdoctask' -Rake::RDocTask.new do |rdoc| - version = File.exist?('VERSION') ? File.read('VERSION') : "" - - rdoc.rdoc_dir = 'rdoc' - rdoc.title = "time_ext #{version}" - rdoc.rdoc_files.include('README*') - rdoc.rdoc_files.include('lib/**/*.rb') +begin + require 'yard' + YARD::Rake::YardocTask.new +rescue LoadError + task :yardoc do + abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard" + end end diff --git a/spec/spec.opts b/spec/spec.opts index 4e1e0d2..5b2e8d9 100644 --- a/spec/spec.opts +++ b/spec/spec.opts @@ -1 +1,2 @@ +--format specdoc --color