Skip to content

Commit b483c24

Browse files
committed
overdue update
1 parent 808f582 commit b483c24

File tree

4 files changed

+68
-62
lines changed

4 files changed

+68
-62
lines changed

_building/building.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
---
22
layout: page
3-
title: "Building ruby-processing projects"
3+
title: Building ruby-processing projects
44
---
5-
### Tools of the Trade ###
65

7-
You will need to install jdk8, maven (apache-maven-3.5), jruby-9.1.16.0+, have access to processing-3.3.7 jars. Note we prefer a local install of [minitest][minitest] for testing. For the moment avoid jdk9+, except for propane development stuff.
6+
# Tools of the Trade
87

9-
### How to build ruby-processing projects ###
10-
Install the processing core jar in your local [maven repository][local], unfortunately you will need to do this until the processing guys (mainly Ben Fry) see the light and convert vanilla processing to use a maven build. Do this for any other jars you require that are not available from maven central.
8+
You will need to install jdk11, maven (apache-maven-3.5+), jruby-9.2.7.0+, and have access to processing jogl jars. Note we prefer a local install of [minitest] for testing. Use jdk11+, except for propane development stuff.
9+
10+
# How to build ruby-processing projects
11+
12+
Install the processing so you can access the processing hacked jogl jars, unfortunately you will need to do this until the processing guys (mainly Ben Fry) see the light and convert vanilla processing to use a maven build. Do this for any other jars you require that are not available from maven central.
1113

1214
```bash
1315
git clone repo
1416
cd repo
1517
rake
1618
```
19+
1720
It really is as simple as that...
1821

1922
We are using a [polyglot maven build][polyglot] and the pom.xml is only produced for reference, if modifications are required modify `pom.rb`, `Rakefile` and `*.gemspec` please don't alter the `Gemfile` (_which is only included for bundler fans_), preferably don't use `bundler` you probably don't need it, and it can't control jruby version, java version, jar version (or much else that is important to JRubyArt/propane). If your crutch is broken why use it?
2023

21-
[local]:https://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html
22-
[polyglot]:https://github.com/takari/polyglot-maven
23-
[minitest]:https://github.com/seattlerb/minitest
24+
[local]: https://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html
25+
[minitest]: https://github.com/seattlerb/minitest
26+
[polyglot]: https://github.com/takari/polyglot-maven

_building/hype.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: page
3-
title: "Building hype library"
3+
title: Building hype library
44
---
55

66
```bash
@@ -17,7 +17,8 @@ touch .mvn/extensions.xml # see below
1717
touch pom.rb # see below
1818
```
1919

20-
### extensions.xml ###
20+
# extensions.xml
21+
2122
This file tells maven to do a polyglot-ruby build
2223

2324
```xml
@@ -31,7 +32,7 @@ This file tells maven to do a polyglot-ruby build
3132
</extensions>
3233
```
3334

34-
### pom.rb ###
35+
# pom.rb
3536

3637
This is the ruby polyglot version of `pom.xml`
3738

@@ -71,14 +72,14 @@ project 'hype' do
7172
final_name 'hype'
7273
end
7374
end
74-
7575
```
76+
7677
Ideally you need apache-maven-3.5.0 installed (at least 3.3.1), to compile with
7778

7879
```bash
7980
mvn package # outputs hype.jar into target folder
8081
```
8182

82-
For JRubyArt wrap `hype.jar` in `library` folder, put `library` folder in a `hype` folder (and put that alondside regular processing libraries in `sketchbook/libraries` linux etc). For propane put nested hype library in `~/.propane/libraries folder` see how to install [contributed][contributed] libraries for propane.
83+
For JRubyArt wrap `hype.jar` in `library` folder, put `library` folder in a `hype` folder (and put that alondside regular processing libraries in `sketchbook/libraries` linux etc). For propane put nested hype library in `~/.propane/libraries folder` see how to install [contributed] libraries for propane.
8384

84-
[contributed]:https://ruby-processing.github.io/propane/contributed
85+
[contributed]: https://ruby-processing.github.io/propane/contributed

_projects/projects.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,58 @@
11
---
22
layout: page
3-
title: "Ruby Processing Projects"
4-
keywords: projects, propane, JRubyArt, toxicgem, atom-k9, language-jruby-art, pbox2d
3+
title: Ruby Processing Projects
4+
keywords: 'projects, propane, JRubyArt, toxicgem, atom-k9, language-jruby-art, pbox2d'
55
---
66

7-
### JRubyArt ###
7+
# JRubyArt
88

9-
The natural successor to ruby-processing, for processing-3.3.7 and jruby-9.1.16.0, requires vanilla processing install. Executable `k9`. Can work without jruby install (using jruby-complete.jar). Features a --watch (-w) mode, where sketch will reload on saved changes. Supports `bare` sketches (like vanilla processing)
9+
The natural successor to ruby-processing, for processing-3.3.7 and jruby-9.1.16.0, since version 2.0 does not require vanilla processing install. Executable `k9`. Can work without jruby install (using jruby-complete.jar). Features a --watch (-w) mode, where sketch will reload on saved changes. Supports `bare` sketches (like vanilla processing)
1010

11-
### propane ###
11+
# propane
1212

13-
An alternative ruby-processing implementation, for processing-3.3.7 and jruby-9.1.16.0, does not require vanilla processing install, does require jruby install. Executable `jruby`. Should be be easier to convert into an exportable app, no reliance on vanilla processing install. Only supports class wrapped sketches.
13+
An alternative ruby-processing implementation, for processing-3.3.7+ and jruby-9.2.7.0, does not require vanilla processing install, does require jruby install. Executable `jruby`. Should be be easier to convert into an exportable app, no reliance on vanilla processing install. Only supports class wrapped sketches.
1414

15-
### PiCrate ###
15+
# PiCrate
1616

17-
An experimental ruby-processing implementation, for processing-3.3.7 and jruby-9.1.16.0, targeting linux and the raspberrypi. Executable `jruby`. Should be be easier to convert into an exportable app, no reliance on vanilla processing install. Only supports class wrapped sketches.
17+
An experimental ruby-processing implementation, for processing-3.3.7 and jruby-9.2.7.0, targeting linux and the raspberrypi. Executable `jruby`. Should be be easier to convert into an exportable app, no reliance on vanilla processing install. Only supports class wrapped sketches.
1818

19-
### pbox2d ###
19+
# pbox2d
2020

2121
Gem wrapper around [jbox2d][pbox2d] for JRubyArt and propane
2222

23-
### toxiclibs ###
23+
# toxiclibs
2424

2525
Gem wrapper around [toxiclibs libraries][toxiclibs] for JRubyArt and propane
2626

27-
### geomerative ###
27+
# geomerative
2828

2929
Gem wrapper around [geomerative library][geomerative] for JRubyArt and propane
3030

31-
### ruby_wordcram ###
31+
# ruby_wordcram
3232

3333
Gem wrapper around [WordCram library][wordcram] for JRubyArt and propane, create word clouds in ruby.
3434

35-
### joonsrenderer ###
35+
# joonsrenderer
3636

3737
Gem wrapper around [joonsrenderer library][joonsrenderer] for JRubyArt and propane, enables sunflow raytracing of sketches
3838

39-
### filters4jruby_art
39+
# filters4jruby_art
4040

4141
A set of GLSL filters for use with JRubyArt (propane), as [example sketches][examples]
4242

43-
### atom-k9 ###
43+
# atom-k9
4444

45-
The [atom-k9][atom-k9] package allows you run JRubyArt sketches from atom editor
45+
The [atom-k9] package allows you run JRubyArt sketches from atom editor
4646

47-
### language-jruby-art ###
47+
# language-jruby-art
4848

49-
The [language-jruby-art][language-jruby-art] provides syntax highlighting and snippets for JRubyArt and propane
49+
The [language-jruby-art] provides syntax highlighting and snippets for JRubyArt and propane
5050

51-
[pbox2d]:https://github.com/ruby-processing/jbox2d
52-
[toxiclibs]:https://github.com/ruby-processing/toxicgem
53-
[geomerative]:https://github.com/ruby-processing/geomerativegem
54-
[language-jruby-art]:https://github.com/ruby-processing/language-jruby-art
55-
[atom-k9]:https://github.com/ruby-processing/atom-k9
56-
[joonsrenderer]:https://github.com/ruby-processing/joonsrenderer
57-
[examples]:https://github.com/ruby-processing/filters4jruby_art/blob/master/README.md
58-
[wordcram]:http://wordcram.org/
51+
[atom-k9]: https://github.com/ruby-processing/atom-k9
52+
[examples]: https://github.com/ruby-processing/filters4jruby_art/blob/master/README.md
53+
[geomerative]: https://github.com/ruby-processing/geomerativegem
54+
[joonsrenderer]: https://github.com/ruby-processing/joonsrenderer
55+
[language-jruby-art]: https://github.com/ruby-processing/language-jruby-art
56+
[pbox2d]: https://github.com/ruby-processing/jbox2d
57+
[toxiclibs]: https://github.com/ruby-processing/toxicgem
58+
[wordcram]: http://wordcram.org/

about.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,37 @@ layout: page
33
title: About
44
permalink: /about/
55
---
6-
### The group ###
7-
The ruby-processing group exists to collect together projects that support creating and running processing sketches in ruby. It is also designed to hide the inevitably high [bus factor][bus] of what is an essentially __one man band__, but I am trying hard to make it otherwise (including evolving the code). You could play your part...
86

9-
There are three main projects [JRubyArt][jruby_art], [PiCrate][picrate] and [propane][propane], [JRubyArt][jruby_art] is the closest to the original ruby-processing and provides a ruby wrapper around the latest [vanilla processing][processing], it depends on a vanilla processing install (but can be configured to not require a jruby install).
7+
# The group
108

11-
[PiCrate][picrate] is a standalone version designed for the [RaspberryPI][rpi].
9+
The ruby-processing group exists to collect together projects that support creating and running processing sketches in ruby. It is also designed to hide the inevitably high [bus factor][bus] of what is an essentially **one man band**, but I am trying hard to make it otherwise (including evolving the code). You could play your part...
1210

13-
[Propane][propane] is a configuration free, complete version of ruby-processing (_does not require installed vanilla processing_) that depends on an installed jruby (_is slightly more experimental however since a modified PApplet is required with jdk9+ propane may take over in future_). Since propane-3.2.0, propane is compiled with jdk11, and thus jdk11 is a requirement.
11+
There are three main projects [JRubyArt][jruby_art], [PiCrate] and [propane], [JRubyArt][jruby_art] is the closest to the original ruby-processing and provides a ruby implementation that approximates to the latest [vanilla processing][processing] (but can be configured to not require a jruby install).
1412

15-
Other projects include the pbox2d gem (a gem wrapper around [jbox2d][jbox2d]), toxiclibs gem (a gem wrapper around [toxiclibs][toxiclibs]) and geomerative gem (a gem wrapper around [geomerative][geomerative]).
13+
[Propane] is a configuration free, complete version of ruby-processing (_does not require installed vanilla processing_) that depends on an installed jruby (_is slightly more experimental however since a modified PApplet is required with jdk9+ propane may take over in future_). Since propane-3.2.0, propane is compiled with jdk11, and thus jdk11 is a requirement.
1614

17-
Not forgetting the atom editor projects [atom-k9][atom-k9] and [language-jruby-art][language]
15+
[PiCrate] is a standalone version designed for the [RaspberryPI][rpi], but can be developed and run 64 bit linux.
1816

19-
#### Martin Prout ####
17+
Other projects include the pbox2d gem (a gem wrapper around [jbox2d]), toxiclibs gem (a gem wrapper around [toxiclibs]) and geomerative gem (a gem wrapper around [geomerative]).
2018

21-
First degree was BSc hons Biochemistry from University of Surrey, I went on to specialize in xenobiotic metabolism (at first drugs, then industrial chemicals and pesticides). I later studied for a computer science degree with the Open University (BSc hons 2:1 but completed insufficient specific modules to be a named degree), course included some smalltalk but mainly java. Subsequently I dabbled a bit with C++, perl python, and even lisp, but got hooked on ruby, particulary ruby-processing. OS experience Windows-98 up to Windows-XP and mainly linux since 2004 (tried gentoo, fedora, even pardus) now using exclusively Archlinux and Mint (Debian). Since November 2012 I have been sole developer/maintainer of [ruby-processing][ruby-processing] (_did update for processing-2.0_), and I have since developed JRubyArt and propane (_for processing-3.0+_) and ensured that jruby-9.2.0.0+ (with support from jruby group) continues to work with ruby-processing, and its descendants.
19+
Not forgetting the atom editor projects [atom-k9] and [language-jruby-art][language]
2220

23-
Personally I can't understand why processing group spawned p5*js (javascript is just horrible), but I learned sufficient to develop atom packages [atom-k9][atom-k9] and [language-jruby-art][language] for JRubyArt / propane.
21+
## Martin Prout
2422

23+
First degree was BSc hons Biochemistry from University of Surrey, I went on to specialize in xenobiotic metabolism (at first drugs, then industrial chemicals and pesticides). I later studied for a computer science degree with the Open University (BSc hons 2:1 but completed insufficient specific modules to be a named degree), course included some smalltalk but mainly java. Subsequently I dabbled a bit with C++, perl python, and even lisp, but got hooked on ruby, particulary ruby-processing. OS experience Windows-98 up to Windows-XP and mainly linux since 2004 (tried gentoo, fedora, even pardus) now using exclusively Archlinux and Mint (Debian). Since November 2012 I have been sole developer/maintainer of [ruby-processing] (_did update for processing-2.0_), and I have since developed JRubyArt and propane (_for processing-3.0+_) and ensured that jruby-9.2.0.0+ (with support from jruby group) continues to work with ruby-processing, and its descendants.
24+
25+
Personally I can't understand why processing group spawned p5*js (javascript is just horrible), but I learned sufficient to develop atom packages [atom-k9] and [language-jruby-art][language] for JRubyArt / propane.
26+
27+
[atom-k9]: https://atom.io/packages/atom-k9
28+
[blog]: http://monkstone.github.io/
29+
[bus]: https://en.wikipedia.org/wiki/Bus_factor
30+
[geomerative]: http://ruby-processing.github.io/geomerativegem/
31+
[jbox2d]: https://github.com/ruby-processing/jbox2d
2532
[jruby_art]: https://ruby-processing.github.io/JRubyArt/
26-
[blog]:http://monkstone.github.io/
27-
[toxiclibs]:http://ruby-processing.github.io/toxicgem/
28-
[geomerative]:http://ruby-processing.github.io/geomerativegem/
29-
[jbox2d]:https://github.com/ruby-processing/jbox2d
30-
[propane]:https://ruby-processing.github.io/propane/
31-
[processing]:https://processing.org/
32-
[atom-k9]:https://atom.io/packages/atom-k9
33-
[language]:https://atom.io/packages/language-jruby-art
34-
[ruby-processing]:https://github.com/jashkenas/ruby-processing
35-
[bus]:https://en.wikipedia.org/wiki/Bus_factor
36-
[picrate]:https://ruby-processing.github.io/PiCrate/
37-
[rpi]:https://www.raspberrypi.org/
33+
[language]: https://atom.io/packages/language-jruby-art
34+
[picrate]: https://ruby-processing.github.io/PiCrate/
35+
[processing]: https://processing.org/
36+
[propane]: https://ruby-processing.github.io/propane/
37+
[rpi]: https://www.raspberrypi.org/
38+
[ruby-processing]: https://github.com/jashkenas/ruby-processing
39+
[toxiclibs]: http://ruby-processing.github.io/toxicgem/

0 commit comments

Comments
 (0)