Skip to content

Commit

Permalink
Amend documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@monkstone
monkstone committed Feb 25, 2018
1 parent c6379c0 commit 66847c1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/about.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ permalink: /about/
categories: jruby_art update
---

[JRubyArt][jruby_art] is a ruby wrapper for [processing-3.3.2][processing]. Create processing sketches in ruby using regular ruby-2.3 syntax, and use the magic [JRuby][jruby] to run them. You can use both rubygems and and regular processing libraries in your sketches. Features run, watch and live modes (uses pry).
[JRubyArt][jruby_art] is a ruby wrapper for [processing-3.3.6][processing]. Create processing sketches in ruby using regular ruby-2.3 syntax, and use the magic [JRuby][jruby] to run them. You can use both rubygems and and regular processing libraries in your sketches. Features run, watch and live modes (uses pry). But you should also be able to use this gem with [propane][propane], you just need to class wrap examples as required.

In general where there is a choice of using a java (processing) method or a regular ruby method you should choose the ruby method (eg use `rand` in place of `random`). Further you should prefer to use `JRuby` classes `Vec2D` and `Vec3D` instead of processings `PVector` class. Processing has a number of convenience methods which are not needed in ruby (eg 'pow' use `**` in JRubyArt) and some static methods have not been implemented in JRubyArt. For the processing `map` method prefer `map1d` ([see example][map1d]) or use `p5map` if you must. Another thing to watch is `color` which is implemented differently in JRubyArt ([see example][color]).

See also my [blog][blog] for more code ideas.

[jruby]: https://jruby.org
[processing]: https://processing.org

[propane]: https://ruby-processing.github.io/propane/
[jruby_art]: https://ruby-processing.github.io/index.html
[color]: https://github.com/ruby-processing/JRubyArt-examples/blob/master/processing_app/basics/color/creating.rb
[map1d]: https://github.com/ruby-processing/JRubyArt-examples/blob/master/processing_app/basics/arrays/array.rb
[map1d]:https://github.com/ruby-processing/JRubyArt-examples/blob/master/processing_app/basics/arrays/array.rb
[blog]:https://monkstone.github.io/

0 comments on commit 66847c1

Please sign in to comment.