Skip to content

Latest commit

 

History

History
151 lines (86 loc) · 3.98 KB

README.md

File metadata and controls

151 lines (86 loc) · 3.98 KB

Runt

  • Runt is a Ruby implementation of select Martin Fowler patterns.
  • TemporalExpressions allow a developer to define patterns of date recurrence using set expressions.

Installation

Add this line to your application's Gemfile:

gem 'runt'

And then execute:

$ bundle

Or install it yourself as:

$ gem install runt

Usage

TODO: Write usage instructions here

Contributing

Current Build Status

Build Status

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Stuff that Needs Formatting

The previous README should be fit into the pretty Markdown format used above.

The remainder of the information it contained can be found below:

= RUNT -- Ruby Temporal Expressions


= INSTALL

* gem install runt

  <b>or</b>

* 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 Runt website[http://runt.rubyforge.org].

Get in touch if you have questions or if Runt causes your computer to burst into flames...

Matt[mailto:[email protected]]

== 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:[email protected]] 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.

The ruby-nyc user's group for their suggestions and feedback.

BlueRobot[http://www.bluerobot.com/web/layouts/] for the CSS used to prettify the Runt website.

Emmett Shear for contributed TExpr#dates code and several thought-provoking feature requests.

Ira Burton for contributed DayIntervalTE class.

Jodi Showers for serialization bug fix.

Pat Maddox for YearTE.

Paul Wright for Time class compatibility.

Ara T. Howard for Numeric class extensions.

Larry Karnowski for BeforeTE, AfterTE, TExpr#dates enhancements, RFC2445 (iCalendar) compliance tests.

Gordon Thiesfeld for fixed Time integration and extended REWeek functionality.

Justin Cunningham for performance optimizations, bug reports and patches.

Bug #19982 and patch submitted by Riley Lynch

The number 12, and the letters E, J, and B.

= Etc...

Author:: Matthew Lipper [email protected] Requires:: Ruby 1.8.0 or later, Date/DateTime classes License:: Copyright 2004 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