doc/main-rdoc/files/README.html in facets-0.7.1 vs doc/main-rdoc/files/README.html in facets-0.7.2
- old
+ new
@@ -54,11 +54,11 @@
<td>README
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Sun Apr 24 22:08:31 EDT 2005</td>
+ <td>Sat May 21 12:05:35 EDT 2005</td>
</tr>
</table>
</div>
<!-- banner header -->
@@ -68,39 +68,46 @@
<div id="contextContent">
<div id="description">
<h1>Ruby Facets</h1>
-<h3>Introduction to Ruby’s Atomic Library</h3>
+<h2>What is this?</h2>
<p>
-Ruby Facets (Fantastic Atomic Core Extensions), is an growing collection of
-methods to complement Ruby’s core and standard libs. It is an
-<em>atomic</em> library in that the methods are, to the greatest degree
-reaonable, packaged individually so that each can be <em>required</em>
-independently. This gives the programmer greater control to include only
-the extra methods that are actually needed and thus boost runtime
-efficiency a bit. The package currently contains over 300 atomic methods,
-spanning over 26 classes and modules.
+Ruby Facets is the a collection of general, pure-Ruby extensions and
+additions for the Ruby programming language. The design falls into two
+parts: the Atomic Methods and the CMMs (Classes, Modules and Mixins).
</p>
+<h3>The Atomic Library</h3>
<p>
-In addition to the atomic methods Facets also includes a large collection
-of addon classes, modules and mixins (which generally utilizing
-Facets’ atomic methods). [Note: These used to exit in a separate lib
-called Carats. This has been deprecated in favor of a single package.]
+The heart of Ruby Facets, which truth be told stands for Fantastic Atomic
+Core Extensions, is an growing collection of methods to complement
+Ruby’s core and standard libs. It is an <em>atomic</em> library in
+that the methods are packaged individually so that each can be
+<em>required</em> independently. This gives the programmer greater control
+to include only the extra methods he or she actually needs. The package
+currently contains over 300 atomic methods, spanning over 26 classes and
+modules.
</p>
+<h3>The Classes, Modules and Mixins</h3>
<p>
+In addition to the atomic methods, Facets also includes a large collection
+of addon classes, modules and mixins. [Note: These used to reside in a
+separate lib called Carats. This has been deprecated in favor of a single
+package.]
+</p>
+<p>
In short, through a single package, the Ruby programmer is treated to a
plethora of programming tools.
</p>
-<h3>Calibre</h3>
+<h2>Calibre</h2>
<p>
Ruby Facets is part of the Calibre project. You can learn more at:
</p>
<pre>
http://calibre.rubyforge.com
</pre>
-<h3>Installation</h3>
+<h2>Installation</h2>
<p>
The easiest way to install is via RubyGems. On the command line enter:
</p>
<pre>
> gem install facets
@@ -112,11 +119,11 @@
<pre>
> tar -xvzf facets-x.y.z.tar.gz
> cd facets--x.y.z
> sudo ruby setup.rb
</pre>
-<h3>Usage</h3>
+<h2>Usage</h2>
<p>
There are quite a few methods, classes and modules. For detailed usage it
is best to refer to the API RDocs. Most is well documented. Assistance in
improving documentation though is always appreciated.
</p>
@@ -179,12 +186,16 @@
into a subdirectory, and can always be require accordingly:
</p>
<pre>
require 'facet/{file-name}'
</pre>
-<h3>Contribute</h3>
<p>
+As for actual examples, well that might require a book. But again, refer to
+the API docs.
+</p>
+<h2>Contribute</h2>
+<p>
The project thrives on contribution. Please feel free to offer any
extension you wish. The criteria for inclusion is fairly light:
</p>
<ul>
<li>Is it generally useful and/or highly interesting?
@@ -196,40 +207,96 @@
</ul>
<p>
If it meets these requirements then it will in all likelihood be accepted
into the main facets lib.
</p>
-<h3>Mascot</h3>
+<h2>Authorship</h2>
<p>
-Does evey good project need a mascot? Well then, Facets has the Raspberry.
-Why the Raspberry? Because it is Red and Faceted, of course. :)
-</p>
-<h3>Authorship</h3>
-<p>
This collection was put together by, and largely written by Thomas Sawyer
-(aka T. Onoma). He can be reached via email at transami at runbox.com.
+(aka T. Onoma). He can be reached via email at transfire at gmail.com.
</p>
<p>
Some parts of this collection were written and/or inspired by other
persons. Fortunately nearly all were copyrighted under the same open
license as this library. In the few excpetions I have included the
copyright notice with the source code. In all cases, I have made every
effort to give credit where credit is due. You will find these thanks and
acknowledgements at the beginning of the source code.
</p>
+<ul>
+<li>Thomas Sawyer
+
+</li>
+<li>Paul Brannan
+
+</li>
+<li>Renald Buter
+
+</li>
+<li>Hal Fulton
+
+</li>
+<li>Gavin Sinclair
+
+</li>
+<li>Michael Granger
+
+</li>
+<li>Michael Neumann
+
+</li>
+<li>Florian Frank
+
+</li>
+<li>Mohammad Khan
+
+</li>
+<li>Derek Lewis
+
+</li>
+<li>Thomas-Ivo Heinen
+
+</li>
+<li>Jan Molic
+
+</li>
+</ul>
<p>
+This package is a collection of work by many persons. The actual code on is
+licensed according to the original authors desires, being one of the
+following: Ruby, GPL, LGPL, MIT, or Artistic. Copies of these licenses
+should accompany this document. Any piece of code not specifically laballed
+shall fall under the Ruby License.
+</p>
+<p>
+[Please Note: I am working to make sure everything is labeled
+appropriately. Please forgive me if I have not done so in a particular
+place —just let me know and I will fix.]
+</p>
+<p>
+Also, I would like to ask all those authors, whose code is collected here,
+to consider allowing me to move to the Ruby license, so one license can
+serve for all.
+</p>
+<h2>License</h2>
+<p>
The collection per collection is licensed as follows:
</p>
<pre>
Ruby Facets, the Fantastic Atomic Core Extensions
- Copyright (c) 2004 Thomas Sawyer
+ Copyright (c) 2004,2005 Thomas Sawyer
Ruby License
</pre>
<p>
The Ruby license is a dual license that also provides for use of the GPL. A
copy of both licenses should accompany this document.
</p>
-<h3>Pitch</h3>
+<h2>Mascot</h2>
+<p>
+Does evey good project need a mascot? Well then, Facets has the Raspberry.
+Why the Raspberry? Because it is Red and Faceted, of course. :)
+</p>
+<h2>Pitch</h2>
<pre>
ALL YOUR BASE ARE BELONG TO RUBY
</pre>
</div>
\ No newline at end of file