:wqMerge branch 'master' of https://github.com/ruby-processing/JRubyArt-examples

Author: monkstone

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by reporting bugs or problems [here][]
+* by suggesting/implementing new features ( _export using warbler would be cool_ )
+* by writing or editing documentation ( _expert Windows users could help write install instructions_ )
+* by contributing examples ( _show your creativity, or translate someone elses masterpiece, you could learn a lot_ )
+  to do this, and to get recognized for your contribution:- clone this repo, and submit a pull request
+* by refactoring examples to be more rubyfied
+* by closing [issues][]
+* by proselytizing JRubyArt, we need more champions
+* by supporting [Processing.org][], nothing to do with us but we rely on them
+* by figuring out if we could replace swing with javafx for control_panel etc
+* by testing / contributing to the [development branch][]
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, ideally include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system. 
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Submit a pull request.][pr]
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+[here]: https://github.com/ruby-processing/JRubyArt/issues
+[issues]: https://github.com/ruby-processing/JRubyArt/issues
+[gist]: https://gist.github.com/
+[fork]: http://help.github.com/fork-a-repo/
+[pr]: http://help.github.com/send-pull-requests/
+[processing.org]: http://processing.org/foundation/
+[development branch]: https://github.com/ruby-processing/JRubyArt

README.md

@@ -1,6 +1,58 @@
 # JRubyArt-examples for JRubyArt-1.1+
-Example sketches for JRubyArt, feel free to contribute your own examples to the contributed section:-
+JRubyArt-examples
+================
 
-The sketches under the processing_app folder approximate to those included with vanilla processing, with the addition of some JRubyArt library sketches. External library sketches
-corresponding to vanilla processing contributed libraries and gem libraries are organised in the external_library folder.
+Many of the vanilla processing example sketches have been translated to ruby-processing, and they are mainly written as 'bare' sketches (ie not class wrapped) in keeping with the original processing.  At runtime these sketches the get wrapped into a Sketch class. Should you prefer you can still write class wrapped sketches, these will work equally well with ruby-processing. Certain sketches must be run with JRuby-Complete (mainly `load_image` and `shader` sketches), this is a [java permissions thing with jruby][]. You should also checkout the [Nature of Code Examples in ruby][] and for the beginner [Learning Processing with Ruby][] for even more examples.
+Includes autorun Rakefiles, in a console cd outer directory and 'rake' to run all autorun examples or eg 'rake shaders' to just run the shader examples. 
 
+### Partial Catalogue (for the lazy)
+
+1. [Basic][]
+
+    1. [structure][]
+    2. [objects][] 
+    3. [arrays][]
+    4. [input][]
+    5. [shape][]
+    6. [image][]
+    7. [control][]
+
+2. [Topics][]
+
+    1. [shaders][]
+    2. [lsystems][]
+    3. [advanced data][]
+    
+3. [Libraries][]
+    1. [fastmath][]
+    2. [vecmath][]
+    3. [control-panel][]
+    4. [video][]
+
+4. [JBox2D][]
+
+### User contributions are most welcome
+[Contributions][] add your [own][]
+
+[Learning Processing with Ruby]:https://github.com/ruby-processing/learning-processing-with-ruby
+[Nature of Code Examples in ruby]:https://github.com/ruby-processing/The-Nature-of-Code-for-JRubyArt
+[Contributions]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/contributed
+[own]:https://github.com/ruby-processing/JRubyArt-examples/blob/master/CONTRIBUTING.md
+[Basic]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics
+[structure]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics/structure
+[objects]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics/objects
+[arrays]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics/arrays
+[control]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics/control
+[shape]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics/shape
+[input]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics/input
+[image]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/basics/image
+[Topics]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/topics
+[lsystems]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/topics/lsystems
+[advanced data]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/topics/advanced_data
+[shaders]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/topics/shaders
+[Libraries]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/library
+[fastmath]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/library/fastmath
+[vecmath]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/library/vecmath
+[video]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/processing_app/library/video
+[control-panel]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/contributed/jwishy.rb
+[JBox2D]:https://github.com/ruby-processing/JRubyArt-examples/tree/master/external_library/ruby_gem/jbox2d