Commit cb09e6aa by Vasily Fedoseyev Committed by Andrew W. Lee

Convert documentation files to Markdown (#697)

* Convert documentation files to Markdown * Add notice about models not being annotated by default to changelog in 3.0
parent d16182f6
spec/**/*.rb spec/**/*.rb
lib/**/*.rb lib/**/*.rb
- -
README.rdoc README.md
CHANGELOG.rdoc CHANGELOG.md
TODO.rdoc TODO.md
== Authors ## Authors
- Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models> - Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models>
- Overhauled by: Alex Chaffee <http://alexch.github.com> alex@stinky.com - Overhauled by: Alex Chaffee <http://alexch.github.com> alex@stinky.com
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
- Maintained by: Alex Chaffee and Cuong Tran - Maintained by: Alex Chaffee and Cuong Tran
- Homepage: http://github.com/ctran/annotate_models - Homepage: http://github.com/ctran/annotate_models
With help from: ### With help from:
- Jack Danger - http://github.com/JackDanger - Jack Danger - http://github.com/JackDanger
- Michael Bumann - http://github.com/bumi - Michael Bumann - http://github.com/bumi
......
This diff is collapsed. Click to expand it.
## Prerequisite
- Install "git-flow" (`brew install git-flow`)
- Install "bump" gem (`gem install bump`)
## Perform a release
- `git flow release start <release>`
- Update the `CHANGELOG.md` file
- `bump current`
- `bump patch`
- `rm -rf dist`
- `rake spec`
- `rake gem`
- `git flow release finish <release>`
- `rake gem:publish`
== Prerequisite
- Install "git-flow" (brew install git-flow)
- Install "bump" gem (gem install bump)
== Perform a release
- git flow release start <release>
- Update the CHANGELOG.rdoc file
- bump current
- bump patch
- rm -rf dist
- rake spec
- rake gem
- git flow release finish <release>
- rake gem:publish
...@@ -60,7 +60,7 @@ namespace :gem do ...@@ -60,7 +60,7 @@ namespace :gem do
end end
gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) } gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
gem.extra_rdoc_files = ['README.rdoc', 'CHANGELOG.rdoc', 'TODO.rdoc'] gem.extra_rdoc_files = ['README.md', 'CHANGELOG.md', 'TODO.md']
gem.files = `git ls-files -- .`.split("\n").reject do |fn| gem.files = `git ls-files -- .`.split("\n").reject do |fn|
fn =~ /^Gemfile.*/ || fn =~ /^Gemfile.*/ ||
......
== TODO ## TODO
- clean up history - clean up history
- change default position back to "top" for all annotations - change default position back to "top" for all annotations
- change 'exclude' to 'only' (double negatives are not unconfusing) - change 'exclude' to 'only' (double negatives are not unconfusing)
== TODO (proposed) ## TODO (proposed)
- push two identical gems, named 'annotate' and 'annotate_models' - push two identical gems, named 'annotate' and 'annotate_models'
- supply two binaries, named 'annotate' and 'annotate_models', since there's already a unix tool named 'annotate' - supply two binaries, named 'annotate' and 'annotate_models', since there's already a unix tool named 'annotate'
......
...@@ -13,8 +13,8 @@ Gem::Specification.new do |s| ...@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
s.description = 'Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema.' s.description = 'Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema.'
s.email = ['alex@stinky.com', 'cuong.tran@gmail.com', 'x@nofxx.com', 'turadg@aleahmad.net', 'jon@cloudability.com'] s.email = ['alex@stinky.com', 'cuong.tran@gmail.com', 'x@nofxx.com', 'turadg@aleahmad.net', 'jon@cloudability.com']
s.executables = ['annotate'] s.executables = ['annotate']
s.extra_rdoc_files = ['README.rdoc', 'CHANGELOG.rdoc', 'TODO.rdoc'] s.extra_rdoc_files = ['README.md', 'CHANGELOG.md', 'TODO.md']
s.files = `git ls-files -z LICENSE.txt *.rdoc *.gemspec bin lib`.split("\x0") s.files = `git ls-files -z LICENSE.txt *.md *.gemspec bin lib`.split("\x0")
s.homepage = 'http://github.com/ctran/annotate_models' s.homepage = 'http://github.com/ctran/annotate_models'
s.licenses = ['Ruby'] s.licenses = ['Ruby']
s.require_paths = ['lib'] s.require_paths = ['lib']
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment