Skip to content

monkstone/cf3ruby

Repository files navigation

cf3ruby

Now updated to be compatible with ruby 2.5, JRubyArt 2.5+ (newer version of ruby-processing), and Processing 3+.*

context-free DSL for ruby-2.5 and CF3 syntax

Very much derived from context-free.rb by Jeremy Ashkenas this version is updated to be more in line with CF3 and ruby 2.5 syntax. NB this version will not work with original ruby-processing.

Installation

To use this library you need install jruby (preferably jruby-9.2+), you will also need ruby-processing/JRubyArt to be installed. There are three ways you can install this library:-

rake test and gem install

Clone this repository,

cd cf3ruby
jruby -S rake test # builds and tests gem (mouse click on frame for test image to show)
jruby -S gem install cf3-1.2.0.gem # may need sudo access

local bundle install

Clone this repository,

cd cf3ruby
# bundle install          # using regular installed bundler may need to set GEM_PATH
jruby -S bundle install # if you installed bundler with jruby

gem install from rubygems

# When rubygems is updatd for this release.

# gem install cf3            # regular install may need to set GEM_PATH env variable
# jruby -S gem install cf3   # jruby install

it couldn't be easier could it?

Usage

Extract the included samples to your home directory (HOME/cf3work/samples)

cf3samples           # should work
jruby -S cf3samples  # else if installed with jruby this should also work

As for running ruby-processing,

k9 --run city.rb # providing you installed both ruby-processing (JRubyArt) and cf3ruby using jruby

You should read the JRubyArt documentation on using rubygems.

Contributing

See CONTRIBUTING.md

Y