Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monkstone/cf3ruby
A ruby context free art DSL for use with ruby-processing
https://github.com/monkstone/cf3ruby
art contextfreeart jruby ruby-processing
Last synced: 9 days ago
JSON representation
A ruby context free art DSL for use with ruby-processing
- Host: GitHub
- URL: https://github.com/monkstone/cf3ruby
- Owner: monkstone
- License: gpl-3.0
- Created: 2013-07-27T20:27:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-09-11T13:55:34.000Z (about 3 years ago)
- Last Synced: 2024-04-25T22:02:46.582Z (6 months ago)
- Topics: art, contextfreeart, jruby, ruby-processing
- Language: Ruby
- Homepage: http://monkstone.github.io/cf3ruby/
- Size: 197 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://github.com/jashkenas/context_free) 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](https://github.com/ruby-processing/JRubyArt) to be installed. There are three ways you can install this library:-
***rake test and gem install***
Clone this repository,
```bash
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,
```bash
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***
```bash
# 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)
```bash
cf3samples # should work
jruby -S cf3samples # else if installed with jruby this should also work
```
As for running ruby-processing,
```bash
k9 --run city.rb # providing you installed both ruby-processing (JRubyArt) and cf3ruby using jruby
```
You should read the [JRubyArt documentation](https://github.com/ruby-processing/JRubyArt/blob/master/README.md) on using rubygems.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
