diff --git a/.gitignore b/.gitignore index ce4e359..a697fa8 100644 --- a/.gitignore +++ b/.gitignore @@ -14,7 +14,7 @@ MANIFEST.MF .dat* .repl_history build/ - +*.jar ## Documentation cache and generated files: /.yardoc/ /_yardoc/ diff --git a/README.md b/README.md index e7f2dfe..b9bb904 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # ArcBall ArcBall functionality for processing (ruby versions) as gem + +### Example Usage +The sketch class need to to inherit from PApplet to work and self should return such an instance. The following is a ruby-processing example, which currently supplies arcball via a library, but gem distribution has its attractions + +```ruby +require 'arcball' + +def setup + size(600, 600, P3D) + smooth(8) + Processing::ArcBall.init(self, 300, 300) + fill 180 +end + +def draw + background(50) + box(300, 300, 300) +end +```