Skip to content
This repository
Browse code

Update README and rename to .rdoc for GitHub formatting.

  • Loading branch information...
commit 72ca793a54a9d9beeb0ceabc8bc7a69b306cb3b6 1 parent 4f964b1
Andrew France authored April 17, 2010
114  README
... ...
@@ -1,114 +0,0 @@
1  
-# -----------------------------------------------------------------
2  
-# Contents:
3  
-# 
4  
-#  + What Ruport Is
5  
-#  + Installation
6  
-#  + Resources
7  
-#  + Hacking
8  
-#
9  
-# = What Ruport Is
10  
-#
11  
-# Ruby Reports (Ruport) is an extensible reporting system.
12  
-# 
13  
-# It aims to be as lightweight as possible while still providing core support
14  
-# for data aggregation and manipulation as well as multi-format rendering 
15  
-# of reports.
16  
-#
17  
-# Ruport provides tools for using a number of data sources, including CSV files,
18  
-# ActiveRecord models, and raw SQL connections via RubyDBI (through ruport-util).
19  
-#
20  
-# Data manipulation is easy as there are standard structures that support
21  
-# record, table, and grouping operations.  These all can be extended to
22  
-# implement custom behavior as needed.
23  
-#
24  
-# For common tasks, Ruport provides formatters for CSV, HTML, PDF, and text-
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.
29  
-#
30  
-# To get a quick feel for what you can accomplish with Ruport, take a look at
31  
-# a few simple examples provided on our web site.
32  
-#
33  
-# http://rubyreports.org/examples.html
34  
-#
35  
-# Since Ruport's core support is intentionally minimalistic, you may be looking
36  
-# for some higher level support for specific needs such as graphing, invoices,
37  
-# report mailing support, etc.  For this, you may wish to take a look at the
38  
-# ruport-util package, which contains some generally useful tools and libraries
39  
-# to extend Ruport's capabilities.
40  
-#
41  
-# = Installation 
42  
-#
43  
-# To install ruport via rubygems:
44  
-#   
45  
-#   sudo gem install ruport 
46  
-#
47  
-# Check to see if it installed properly:
48  
-#
49  
-#   ruby -rubygems -e "require 'ruport'; puts Ruport::VERSION"
50  
-#
51  
-# If you get an error, please let us know on our mailing list. 
52  
-#
53  
-# Dependencies Details:
54  
-#   
55  
-#  -- formatting
56  
-#
57  
-# Ruport relies on PDF::Writer and FasterCSV for its formatting support.
58  
-# If you want to make use of textile helpers, you'll also need RedCloth.
59  
-#
60  
-#  -- database interaction
61  
-#
62  
-# If you wish to use Ruport to report against a rails project, 
63  
-# a camping project, or do standalone acts_as_reportable reports, you'll need
64  
-# ActiveRecord and the acts_as_reportable gem.
65  
-#
66  
-# If you want to use Ruport::Query for raw SQL support, you'll need to 
67  
-# install ruport-util, RubyDBI and whatever database drivers you might need.
68  
-#
69  
-# = Resources              
70  
-#
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.
79  
-# This software is on the move, so the list is the most reliable way of getting
80  
-# up to date information.
81  
-#
82  
-#  -  You can sign up and/or view the archives here:
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.
87  
-#
88  
-#  -  The latest stable API documentation is available at:
89  
-#     http://api.rubyreports.org
90  
-#
91  
-#  -  Our Trac is at: http://code.rubyreports.org/ruport
92  
-#     You may use the username ruport and password blinky to file tickets.
93  
-#
94  
-# = Hacking
95  
-#
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  
-
105  README.rdoc
Source Rendered
... ...
@@ -0,0 +1,105 @@
  1
+= What Ruport Is
  2
+
  3
+Ruby Reports (Ruport) is an extensible reporting system.
  4
+
  5
+It aims to be as lightweight as possible while still providing core support
  6
+for data aggregation and manipulation as well as multi-format rendering
  7
+of reports.
  8
+
  9
+Ruport provides tools for using a number of data sources, including CSV files,
  10
+ActiveRecord models, and raw SQL connections via RubyDBI (through ruport-util).
  11
+
  12
+Data manipulation is easy as there are standard structures that support
  13
+record, table, and grouping operations.  These all can be extended to
  14
+implement custom behavior as needed.
  15
+
  16
+For common tasks, Ruport provides formatters for CSV, HTML, PDF, and text-
  17
+based reports.  However, the real power lies in building custom report
  18
+controllers and formatters.  The base formatting libraries provide a number
  19
+of helper functions that will let you build complex reports while maintaining
  20
+a DRY and consistent interface.
  21
+
  22
+To get a quick feel for what you can accomplish with Ruport, take a look at
  23
+a few simple examples provided on our web site.
  24
+
  25
+http://rubyreports.org/examples.html
  26
+
  27
+Since Ruport's core support is intentionally minimalistic, you may be looking
  28
+for some higher level support for specific needs such as graphing, invoices,
  29
+report mailing support, etc.  For this, you may wish to take a look at the
  30
+ruport-util package, which contains some generally useful tools and libraries
  31
+to extend Ruport's capabilities.
  32
+
  33
+= Installation
  34
+
  35
+To install ruport via rubygems:
  36
+
  37
+  sudo gem install ruport
  38
+
  39
+Check to see if it installed properly:
  40
+
  41
+  ruby -rubygems -e "require 'ruport'; puts Ruport::VERSION"
  42
+
  43
+If you get an error, please let us know on our mailing list.
  44
+
  45
+=== Dependencies
  46
+
  47
+==== Formatting
  48
+
  49
+Ruport relies on PDF::Writer and FasterCSV for its formatting support.
  50
+If you want to make use of textile helpers, you'll also need RedCloth.
  51
+
  52
+==== Database interaction
  53
+
  54
+If you wish to use Ruport to report against a rails project,
  55
+a camping project, or do standalone acts_as_reportable reports, you'll need
  56
+ActiveRecord and the acts_as_reportable gem.
  57
+
  58
+If you want to use Ruport::Query for raw SQL support, you'll need to
  59
+install ruport-util, RubyDBI and whatever database drivers you might need.
  60
+
  61
+= Resources
  62
+
  63
+Our developers have published a free-content book about all things
  64
+Ruport, including complete coverage of acts_as_reportable and some of
  65
+ruport-util's features.  This book serves as the definitive guide to
  66
+Ruport, so all users should become acquainted with it:
  67
+
  68
+  http://ruportbook.com
  69
+
  70
+The next best way to get help and make suggestions is the Ruport mailing list.
  71
+This software is on the move, so the list is the most reliable way of getting
  72
+up to date information.
  73
+
  74
+-  You can sign up and/or view the archives here:
  75
+   http://groups.google.com/group/ruby-reports
  76
+
  77
+If you are looking to dig a little deeper, there are a couple more resources
  78
+that may be helpful to you.
  79
+
  80
+-  The latest stable API documentation is available at:
  81
+   http://api.rubyreports.org
  82
+
  83
+-  Our issues tracker is at http://github.com/ruport/ruport/issues
  84
+
  85
+= Hacking
  86
+
  87
+If you'd like to contribute code to Ruport, please join our development
  88
+mailing list, and let us know what you'd like to do!
  89
+
  90
+http://groups.google.com/group/ruport-dev
  91
+
  92
+The main Git repository is on GitHub:
  93
+http://github.com/ruport/ruport
  94
+
  95
+It also may be worthwhile to join this list if you plan on running edge
  96
+versions of Ruport, as this is where we make announcements about major
  97
+breakage in trunk.
  98
+
  99
+We are very responsive to contributors, and review every patch we receive
  100
+fairly quickly.  Most contributors who successfully get a patch or two applied
  101
+are given write access to the repositories and invited to join Ruport's
  102
+development team.  Since we view every user as potential contributor, this
  103
+approach works well for us.
  104
+
  105
+So if you want to help out with Ruport, we'll happy accept your efforts!
6  Rakefile
@@ -31,7 +31,7 @@ begin
31 31
     gemspec.email = 'gregory.t.brown@gmail.com'
32 32
     gemspec.homepage = 'http://rubyreports.org'
33 33
     gemspec.authors = ['Gregory Brown', 'Mike Milner', 'Andrew France']
34  
-    gemspec.rdoc_options = ['--title', 'Ruport Documentation', '--main', 'README', '-q']
  34
+    gemspec.rdoc_options = ['--title', 'Ruport Documentation', '--main', 'README.rdoc', '-q']
35 35
     gemspec.add_dependency 'fastercsv'
36 36
     gemspec.add_dependency 'pdf-writer', '= 1.1.8'
37 37
   end
@@ -40,11 +40,11 @@ rescue LoadError
40 40
 end
41 41
 
42 42
 Rake::RDocTask.new do |rdoc|
43  
-  rdoc.rdoc_files.include( "README",
  43
+  rdoc.rdoc_files.include( "README.rdoc",
44 44
                            #"CHANGELOG",
45 45
                            "AUTHORS", "COPYING",
46 46
                            "LICENSE", "lib/" )
47  
-  rdoc.main     = "README"
  47
+  rdoc.main     = "README.rdoc"
48 48
   rdoc.rdoc_dir = "doc/html"
49 49
   rdoc.title    = "Ruport Documentation"
50 50
 end

0 notes on commit 72ca793

Please sign in to comment.
Something went wrong with that request. Please try again.