README.rdoc in annotate-2.6.0.beta2 vs README.rdoc in annotate-2.6.0

- old
+ new

@@ -31,11 +31,11 @@ class LineItem < ActiveRecord::Base belongs_to :product . . . It also annotates geometrical columns, geom type and srid, when using -`SpatialAdapter` or `PostgisAdapter`: +`SpatialAdapter`, `PostgisAdapter` or `PostGISAdapter`: # == Schema Info # # Table name: trips # @@ -117,28 +117,20 @@ If you want to always skip annotations on a particular model, add this string anywhere in the file: # -*- SkipSchemaAnnotations -To generate a configuration file (in the form of a `.rake` file), to set -default options: - - rails g annotate:install - -Edit this file to control things like output format, where annotations are -added (top or bottom of file), and in which artifacts. - - === Configuration in Rails To generate a configuration file (in the form of a `.rake` file), to set default options: rails g annotate:install Edit this file to control things like output format, where annotations are added (top or bottom of file), and in which artifacts. + == Rails Integration By default, once you've generated a configuration file, annotate will be executed whenever you run `rake db:migrate` (but only in development mode). If you want to disable this behavior permanently, edit the `.rake` file and @@ -146,11 +138,11 @@ 'skip_on_db_migrate' => "false", To: - 'skip_on_db_migrate' => "try", + 'skip_on_db_migrate' => "true", If you want to run `rake db:migrate` as a one-off without running annotate, you can do so with a simple environment variable, instead of editing the `.rake` file: @@ -215,60 +207,41 @@ gem 'kramdown', :groups => [:development], :require => false == WARNING -Note that this code will blow away the initial/final comment block in your -models if it looks like it was previously added by this gem, so you don't want -to add additional text to an automatically created comment block. +<b>Don't add text after an automatically-created comment block.</b> This tool +will blow away the initial/final comment block in your models if it looks like +it was previously added by this gem. -BACK UP YOUR MODELS BEFORE USING THIS TOOL! +Be sure to check the changes that this tool makes! If you are using Git, +you may simply check your project's status after running `annotate`: + $ git status +If you are not using a VCS (like Git, Subversion or similar), please tread +extra carefully, and consider using one. + == Links - Factory Girl: http://github.com/thoughtbot/factory_girl - Object Daddy: http://github.com/flogic/object_daddy - Machinist: http://github.com/notahat/machinist - Fabrication: http://github.com/paulelliott/fabrication - SpatialAdapter: http://github.com/pdeffendol/spatial_adapter - PostgisAdapter: http://github.com/nofxx/postgis_adapter +- PostGISAdapter: https://github.com/dazuma/activerecord-postgis-adapter == License Released under the same license as Ruby. No Support. No Warranty. +== Code Status +{<img src="https://travis-ci.org/ctran/annotate_models.png" />}[https://travis-ci.org/ctran/annotate_models] +{<img src="https://gemnasium.com/ctran/annotate_models.png" />}[https://gemnasium.com/ctran/annotate_models] + == Authors -- 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 -- Gemmed by: Cuong Tran <http://github.com/ctran> ctran@pragmaquest.com -- Maintained by: Alex Chaffee and Cuong Tran -- Homepage: http://github.com/ctran/annotate_models +{See AUTHORS.rdoc}[link:AUTHORS.rdoc]. -With help from: - -- Jack Danger - http://github.com/JackDanger -- Michael Bumann - http://github.com/bumi -- Henrik Nyh - http://github.com/henrik -- Marcos Piccinini - http://github.com/nofxx -- Neal Clark - http://github.com/nclark -- Jacqui Maher - http://github.com/jacqui -- Nick Plante - http://github.com/zapnap - http://blog.zerosum.org -- Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com -- Bob Potter - http://github.com/bpot -- Gavin Montague - http://github.com/govan -- Alexander Semyonov - http://github.com/rotuka -- Nathan Brazil - http://github.com/bitaxis -- Ian Duggan http://github.com/ijcd -- Jon Frisby http://github.com/mrjoy -- Tsutomu Kuroda -- Kevin Moore -- Philip Hallstrom -- Brent Greeff -- Paul Alexander -- Dmitry Lihachev -- qichunren - -and many others that I may have forgotten to add.