Changeset 1301 for ruport/trunk

Show
Ignore:
Timestamp:
04/14/08 09:53:06 (9 months ago)
Author:
sandal
Message:

README update

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • ruport/trunk/README

    r1176 r1301  
    1616# 
    1717# Ruport provides tools for using a number of data sources, including CSV files, 
    18 # ActiveRecord models, and raw SQL connections via RubyDBI. 
     18# ActiveRecord models, and raw SQL connections via RubyDBI (through ruport-util). 
    1919# 
    2020# Data manipulation is easy as there are standard structures that support 
    …… 
    2323# 
    2424# For common tasks, Ruport provides formatters for CSV, HTML, PDF, and text- 
    25 # based reports.  However, the real power lies in building custom renderers and 
    26 # formatters.  The base formatting libraries provide a number of helper 
    27 # functions that will let you build complex reports while maintaining a DRY and 
    28 # consistent interface. 
     25# based reports.  However, the real power lies in building custom report 
     26# controllers and formatters.  The base formatting libraries provide a number  
     27# of helper functions that will let you build complex reports while maintaining  
     28# a DRY and consistent interface. 
    2929# 
    3030# To get a quick feel for what you can accomplish with Ruport, take a look at 
    …… 
    4141# = Installation  
    4242# 
    43 # To install ruport via rubygems with all it's dependencies (except DBI): 
     43# To install ruport via rubygems: 
    4444#    
    45 #   sudo gem install ruport -y 
     45#   sudo gem install ruport  
    4646# 
    4747# Check to see if it installed properly: 
    …… 
    4949#   ruby -rubygems -e "require 'ruport'; puts Ruport::VERSION" 
    5050# 
    51 # If you get an error, please consult the mailing list.  
     51# If you get an error, please let us know on our mailing list.  
    5252# 
    5353# Dependencies Details: 
    …… 
    6262# If you wish to use Ruport to report against a rails project,  
    6363# a camping project, or do standalone acts_as_reportable reports, you'll need 
    64 # ActiveRecord. 
     64# ActiveRecord and the acts_as_reportable gem. 
    6565# 
    6666# If you want to use Ruport::Query for raw SQL support, you'll need to  
    67 # install RubyDBI and whatever database drivers you might need. 
     67# install ruport-util, RubyDBI and whatever database drivers you might need. 
    6868# 
    69 # = Resources 
     69# = Resources               
    7070# 
    71 # The best way to get help and make suggestions is the Ruport mailing list. 
     71# Our developers have published a free-content book about all things 
     72# Ruport, including complete coverage of acts_as_reportable and some of  
     73# ruport-util's features.  This book serves as the definitive guide to  
     74# Ruport, so all users should become acquainted with it: 
     75#  
     76#   http://ruportbook.com 
     77# 
     78# The next best way to get help and make suggestions is the Ruport mailing list. 
    7279# This software is on the move, so the list is the most reliable way of getting 
    7380# up to date information. 
    7481# 
    7582#  -  You can sign up and/or view the archives here: 
    76 #     http://groups.google.com/group/ruby-reports 
     83#     http://groups.google.com/group/ruby-reports                                                    
     84# 
     85# If you are looking to dig a little deeper, there are a couple more resources 
     86# that may be helpful to you. 
    7787# 
    7888#  -  The latest stable API documentation is available at: 
    …… 
    8494# = Hacking 
    8595# 
    86 # If you'd like to work on Ruport, please post on the list and let us know what 
    87 # you're interested in doing, or contact Gregory Brown or Michael Milner if you 
    88 # have questions. 
     96# If you'd like to contribute code to Ruport, please join our development  
     97# mailing list, and let us know what you'd like to do! 
     98# 
     99#   http://groups.google.com/group/ruport-dev 
     100#  
     101# It also may be worthwhile to join this list if you plan on running edge 
     102# versions of Ruport, as this is where we make announcements about major  
     103# breakage in trunk.  
     104# 
     105# We are very responsive to contributors, and review every patch we receive 
     106# fairly quickly.  Most contributors who successfully get a patch or two applied 
     107# are given write access to the repositories and invited to join Ruport's  
     108# development team.  Since we view every user as potential contributor, this 
     109# approach works well for us. 
     110# 
     111# So if you want to help out with Ruport, we'll happy accept your efforts! 
     112 
     113 
     114