Browse files

improved README?

  • Loading branch information...
1 parent c521bab commit 7dc2fbe2bae915afc9cf73cc657132e49610e8e6 @monkstone monkstone committed Jul 24, 2013
Showing with 129 additions and 17 deletions.
  1. +5 −0 .yardopts
  2. +33 −0 CONTRIBUTING.md
  3. +39 −0 LICENSE.md
  4. +52 −17 README.md
View
5 .yardopts
@@ -0,0 +1,5 @@
+--markup markdown
+-
+CONTRIBUTING.md
+LICENSE.md
+README.md
View
33 CONTRIBUTING.md
@@ -0,0 +1,33 @@
+## 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
+* by suggesting new features
+* by writing or editing documentation
+* by contributing examples
+* by refactoring examples to be more rubyfied
+* by closing [issues][]
+* by proselytizing ruby-processing, we need more champions
+* by supporting [Processing.org][], nothing to do with us but we rely on them
+
+## 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. [Create a topic branch.][branch]
+3. [Submit a pull request.][pr]
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+[issues]: https://github.com/rubygems/gems/issues
+[gist]: https://gist.github.com/
+[fork]: http://help.github.com/fork-a-repo/
+[pr]: http://help.github.com/send-pull-requests/
+[processing]: http://processing.org/foundation/
View
39 LICENSE.md
@@ -0,0 +1,39 @@
+Ruby-Processing is released under the MIT License.
+You can do pretty much whatever you'd like with it.
+
+___
+
+Copyright (c) 2008 omygawshkenas
+
+Permission is hereby granted, free of charge,
+to any person obtaining a copy of this software
+and associated documentation files (the "Software"),
+to deal in the Software without restriction,
+including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission
+notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY
+OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+___
+
+Ruby-Processing also distributes core components
+of both [JRuby][] and [Processing][] both of which are
+licensed under the GNU lesser public license
+
+[jruby]: http://www.jruby.org/
+[processing]: http://www.processing.org/
View
69 README.md
@@ -1,27 +1,62 @@
-Ruby Processing
-==========
+# Ruby-Processing
+A ruby wrapper around [Processing][] built using [JRuby][], which allows you code processing sketches in ruby.
+[processing]: http://www.processing.org/
-This is the official source code for the development version of ruby-processing, which is currently based on [processing-2.0.1](https://processing.org/download/), and [jruby-1.7.4](http://www.jruby.org/).
+## Installation
+Either clone this repo to your local Mac/Linux/Windows system
+```bash
+git clone https://github.com/monkstone/ruby-processing.git
+```
+Or download an release snapshot and unzip that followed by
+```bash
+cd ruby-processing
+rake # build and test gem
+gem install ruby-processing-2.1.0.gem # to install gem
+```
+Or if using jruby
+```bash
+jruby -S gem ruby-processing-2.1.0.gem # to install gem
+```
-It is entirely possible that any issues you may experience with this version of ruby-processing may come from either source, both of which are still in active development otherwise you can probably blame @monkstone. It is better that any "bugs" are reported [here](https://github.com/monkstone/ruby-processing/issues?direction=desc&sort=created&state=open) first unless you are absolutely sure that [processing-2.0.1](https://github.com/processing/processing/issues) or [jruby](https://github.com/jruby/jruby/issues?state=open) are to blame. This build has been tested on both linux and MacOSX, I would be keen to hear from any MacOSX and Windows users and how it works for them. The build downloads processing-2.0.1 (the Mac version as it smallest that provides the required jars) It is on your conscience whether you make a donation to [processing.org](http://processing.org/foundation/). Also included is jruby-complete (version 1.7.4), which seems to be required to run shader sketches, further its inclusion also means you do need to have jruby installed to run ruby-processing.
+## Documentation
+# Usage Example
-What's new
-----------------
+```bash
+rp5 run my_sketch.rb
+```
+where a simple my_sketch.rb could look like this
+
+```ruby
+def setup
+ size 400, 400
+ fill 255
+end
+
+def draw
+ background 0
+ ellipse mouse_x, mouse_y, 100, 100
+end
+```
-New capabilities since processing-2.0 include ability to use OPENGL VBO (PShape) and GLSL shaders (PShader), to keep abreast of latest developments check out the [codeanticode blog](http://codeanticode.wordpress.com/2013/06/04/processing-2-0-is-out-processing-2-0-is-in/). Some worked examples using new feature are included in the samples. The update to the latest jruby is also significant as the default is to run with ruby-1.9 support, and there have been many performance improvements. To use the invoke-dynamic java support for dynamic language, use java-7+ (NB: on the Mac need Intel-based Mac running Mac OS X version 10.7.3 and above to install java 7 otherwise use java 6). Many more worked examples are included.
+## Supported Ruby Version
-The original version
----------------------------
+This library has been tested with the following ruby implementations
+
+* Ruby 1.9.3
+* Ruby 2.0.0
+* [JRuby][]
+
+[jruby]: http://www.jruby.org/
+
+[License][]
+
+[license]: LICENSE.md
+
+## What's new
+
+New capabilities since processing-2.0 include ability to use OPENGL VBO (PShape) and GLSL shaders (PShader), to keep abreast of latest developments check out the [codeanticode blog](http://codeanticode.wordpress.com/2013/06/04/processing-2-0-is-out-processing-2-0-is-in/). Some worked examples using new feature are included in the samples. The update to the latest jruby is also significant as the default is to run with ruby-1.9 support, and there have been many performance improvements. To use the invoke-dynamic java support for dynamic language, use java-7+ (NB: on the Mac need Intel-based Mac running Mac OS X version 10.7.3 and above to install java 7 otherwise use java 6). Many more worked examples are included.
-NB: Version 1.0.11 is the last version to be available as a rubygem (processing-1.5.1, jruby-1.6.5)
-```bash
-gem install ruby-processing
-```
-The current version 2.1.0 is available as autobuild archive download [here](https://github.com/monkstone/ruby-processing/releases/tag/2.1.0), or you really might as well clone this development version. NB: the gem is too big to be hosted at rubygems.org, so it will never be located there.
-Get Involved
-------------------
-[Fork it](https://help.github.com/articles/fork-a-repo) / [fixit](https://github.com/jruby/jruby/issues?state=open) / improve it / [add samples](https://github.com/monkstone/ruby-processing/tree/master/samples) / promote it

0 comments on commit 7dc2fbe

Please sign in to comment.