Notes:
= RUNT -- Ruby Temporal Expressions
* Runt is a Ruby[http://www.ruby-lang.org/en/] implementation of select Martin Fowler patterns[http://www.martinfowler.com/articles].
* <em>TemporalExpression</em>s allow a developer to define patterns of date recurrence using set expressions.
---
= INSTALL
* Unpack the Runt distribution.
$ tar -xzvf runt-<version>.tar.gz
* cd $UNPACK_DIR/runt/
* execute:
$ ruby setup.rb config
$ ruby setup.rb setup
$ ruby setup.rb install (may require root privilege)
<b>or</b>
$ ruby setup.rb --help
for more options.
---
= QUICK START
* require 'runt'
* See http://runt.rubyforge.org/doc/index.html
* See $UNPACK_DIR/runt/test/*.rb for example usage.
* See this mini-TemporalExpression tutorial[http://runt.rubyforge.org/doc/files/doc/tutorial_te_rdoc.html]
* See http://www.chronicj.org/apidocs/index.html for better commented source (JavaDoc)
Get in touch if you have questions or if Runt causes your computer to burst into flames...
Matt[mailto:matt@digitalclash.com]
---
== Credits
Rubyforge[http://rubyforge.org] for hosting this project.
M.Fowler[http://martinfowler.com], Matz[http://ruby-lang.org],
T.Funaba (Date/DateTime[http://www.funaba.org/en/ruby.html]),
J.Weirich (Rake[http://rake.rubyforge.org]),
PragmaticProgrammers[http://pragmaticprogrammer.com], and everyone on
ruby-talk[mailto:ruby-talk@ruby-lang.org] for their shameless public display
of smartness.
Hal Fulton, Mauricio Fernandez, and Mark Hubbart for the
thread[http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/95465] on c.l.r.
that inspired a more Ruby-esque syntax for creating TE's. 2X Thanks to Hal, for
taking the time to exchange ideas off-line.
BlueRobot[http://www.bluerobot.com/web/layouts/] for the CSS used to prettify the Runt website.
The number 12, and the letters E and J.
---
= Etc...
Author:: Matthew Lipper <matt@digitalclash.com>
Requires:: Ruby 1.8.0 or later, Date/DateTime classes
License:: Copyright 2003 by Digital Clash LLC.
Released under the Apache Software license (see LICENSE.txt)
included in the distribution.
= Warranty
This software is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantibility and fitness for a particular
purpose.
link://../dcl-small.gif
Changes:
= Runt Changelog
== Version 0.1.0
* Inspired by suggestions[http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/95465] on c.l.r.,
did massive renaming and refactoring to make source more Ruby-esque:
- TemporalExpression class => TExpr
- DatePrecision module => DPrecision (file name changed also)
- TimePoint class => PDate (file name changed also)
- Added transparent use of bitwise set operators ( & , | ) for building composite expressions
- Added transparent use of - operator for diff expressions
* Updated TE Tutorial to reflect new and improved syntax usage
* Skipped several version numbers to celebrate
|
