README in lexrupy-rails-footnotes-3.3.2 vs README in lexrupy-rails-footnotes-3.4

- old
+ new

@@ -1,10 +1,8 @@ -Copyright (c) 2008 José Valim (jose.valim at gmail dot com) -Site: http://www.pagestacker.com/ -Blog: http://josevalim.blogspot.com/ +Rails Footnotes License: MIT -Version: 3.3.2 +Version: 3.4 You can also read this README in pretty html at the GitHub project Wiki page http://github.com/josevalim/rails-footnotes/wikis/home @@ -21,29 +19,34 @@ Installation ------------ -Install Rails Footnotes is very easy. It is stored in GitHub, so if you -have never installed a gem via GitHub run the following: +Install Rails Footnotes is very easy. If you are running on Rails 2.3 just run +the following: - gem sources -a http://gems.github.com + gem sources -a http://gems.github.com + sudo gem install josevalim-rails-footnotes -Then install the gem: - - sudo gem install josevalim-rails-footnotes - In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development): config.gem "josevalim-rails-footnotes", :lib => "rails-footnotes", :source => "http://gems.github.com" If you want it as plugin, just do: + script/plugin install git://github.com/josevalim/rails-footnotes.git + +If you are running on Rails 2.2 or Rails 2.1 you should do: + cd myapp git clone git://github.com/josevalim/rails-footnotes.git - rm -rf vendor/plugins/rails-footnotes/.git + cd vendor/plugins/rails-footnotes + git checkout VERSION_NUMBER + rm -rf ./.git +Where you should replace VERSION_NUMBER for "v3.3.2" for Rails 2.2 and "v3.2.2" +for Rails 2.1 (without the quotes). Instalation for Linux --------------------- If you are running Linux and using gedit as default editor you can use rails-footnotes @@ -53,20 +56,14 @@ If you installed as a plugin: cd vendor/plugins/footnotes/ sh linux_install.sh -If you installed and configured as a gem: +If you installed and configured as a gem just run with your user (without sudo): - mkdir footnotes - cd footnotes - gem unpack josevalim-rails-footnotes - cd josevalim-rails-footnotes-X.X.X/bin # where X.X.X is the current version - sh linux_install.sh + rails-footnotes-linux-configure -Note: your sudo password will be asked - After theese steps you should be able to click on links created by footnotes plugin and Gedit should open. If you use Firefox 3 or newer, first time you click on a link it will ask you a confirmation to open txmt url with the txmt_handler, click yes and it's all done. * If for some reason urls not work just after instalation, try to refresh your gnome session (logout and login again). * If you use firefox 2 or older, see Usage section to get more information about registering a url handler. @@ -102,24 +99,10 @@ Finally, you can control which notes you want to show. The default are: Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general] -Early versions --------------- - -If you are running on Rails 2.1.x, you should use Footnotes v3.2.2: - - cd myapp - git clone git://github.com/josevalim/rails-footnotes.git - cd vendor/plugins/rails-footnotes - git checkout v3.2.2 - rm -rf ./.git - -If you are using earlier than 2.1, please upgrade your app. =) - - Creating your own notes ----------------------- Create your notes to integrate with Footnotes is easy. @@ -163,9 +146,20 @@ end Then put in your environment: Footnotes::Filter.notes += [:current_user] + + +Bugs and Feedback +----------------- + +If you discover any bugs, please send an e-mail to jose.valim@gmail.com +If you just want to give some positive feedback or drop a line, that's fine too! =) + +Copyright (c) 2009 José Valim +http://www.pagestacker.com/ +http://josevalim.blogspot.com/ Version 2.0 -----------