edu_draw 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfc3b98dd75cc8bba96e5c4232b6fd63af037220
-  data.tar.gz: 7ad1c99a69f9146c9ec8b9c2fdc8d3d58c1591ea
+  metadata.gz: 2933de9336d411206319c9eca057e7d3606ec48a
+  data.tar.gz: 0ca6d99f9bb2f58f6f5a900fe577e108250ef970
 SHA512:
-  metadata.gz: 94cdaeefbc9b682466f99041b32632e0fcb167f92140cd4d363d6cb67c6926e52b8a25f14d7191a7bf636207213aa7c4e23839bbf1a0f8bc1da7b0bea93d3851
-  data.tar.gz: 1516ae2a65123eebbe63a900f9500d744635c320cf71c79e08b34ce00d17c59f085cce7a65d6afd42ce9c25613e7818e790e1ac89254e79cadff63cc1d6ac10e
+  metadata.gz: 40ec8360a716f3a9fed464665f731fd1ce2ab04067a4cbdb211755b4c5a4cfba8251dfcaed6fed88bfd5c885a78520d6f9e9a472d78ccaca5339825f39e837ae
+  data.tar.gz: 19e4c224ffab789f881fb246388522311ff06bebf728d40687423a5d69a845c2abb9f7f3ed3813b43af093061df6114427bedd845f368d527d5be6c84d4652ef

data/README.md

@@ -2,7 +2,8 @@
 Simple ruby drawing API based on gosu meant for educational purposes.
 
 ## Install
-`gem install edu_draw`
+
+		gem install edu_draw
 
 If you run into any problems its most likely because of [gosu](https://github.com/jlnr/gosu/wiki/Ruby-Tutorial), as this is the only runtime dependency of edu_draw.
 
@@ -10,118 +11,116 @@ If you run into any problems its most likely because of [gosu](https://github.co
 There are only two classes: A sheet to draw on and a pen to draw with. The sheet is also the window. Unfortunately, the underlying engine only supports really one window, so you should only create one sheet per program. This is done as follows:
 First, load edu_draw into your program
 
-`require "edu_draw"`
+		require "edu_draw"
 
 Then, create the sheet
 
-`sheet = EduDraw::Sheet.new x: 500, y: 600, title: "It works"`
+		sheet = EduDraw::Sheet.new x: 500, y: 600, title: "It works"
 
 Now that you have a sheet, that is 500 pixels wide and 600 pixels high, you can create pens for this sheet to draw on.
 
-`green_pen = sheet.new_pen x: 100, y: 20`
+		green_pen = sheet.new_pen x: 100, y: 20
 
 Green is the default color for pens but you can have any color using the `color` parameter.
 
 Now it's time to draw a rectangle!
 
-```
-green_pen.move 100
-green_pen.turn_right 90
-green_pen.move 80
-green_pen.turn_right 90
-green_pen.move 100
-green_pen.turn_right 90
-green_pen.move 80
-```
+
+		green_pen.move 100
+		green_pen.turn_right 90
+		green_pen.move 80
+		green_pen.turn_right 90
+		green_pen.move 100
+		green_pen.turn_right 90
+		green_pen.move 80
 
 
 When you are done drawing, you have to make one final call to the sheet, to actually display the window with your drawings.
 
-`sheet.show`
+		sheet.show
 
 The whole program looks like this:
 
-```ruby
-require "edu_draw"
 
-sheet = EduDraw::Sheet.new x: 500, y: 600, title: "A beautiful rectangle"
-green_pen = sheet.new_pen(x: 100, y: 20)
+		require "edu_draw"
 
-green_pen.move 100
-green_pen.turn_right 90
-green_pen.move 80
-green_pen.turn_right 90
-green_pen.move 100
-green_pen.turn_right 90
-green_pen.move 80
+		sheet = EduDraw::Sheet.new x: 500, y: 600, title: "A beautiful rectangle"
+		green_pen = sheet.new_pen(x: 100, y: 20)
 
-sheet.show
-```
+		green_pen.move 100
+		green_pen.turn_right 90
+		green_pen.move 80
+		green_pen.turn_right 90
+		green_pen.move 100
+		green_pen.turn_right 90
+		green_pen.move 80
+
+		sheet.show
 
 ### Areas / Filled shapes
 You can also draw filled or party-filled shapes. Here is an short example, that can be also found in the examples folder:
-```ruby
-require "edu_draw"
 
-sheet = EduDraw::Sheet.new(x: 150, y: 150)
-pen = sheet.new_pen(x: 52, y: 10)
+		require "edu_draw"
+
+		sheet = EduDraw::Sheet.new(x: 150, y: 150)
+		pen = sheet.new_pen(x: 52, y: 10)
 
-# Every move in the fill-block will create a filled a shape
-pen.fill do
-	5.times do
-		pen.move 40
-		pen.turn_right 36
-	end
-end
+		# Every move in the fill-block will create a filled a shape
+		pen.fill do
+			5.times do
+				pen.move 40
+				pen.turn_right 36
+			end
+		end
 
-#Every move out of the fill block just draws a line
-# Those 10 moves result in a half-filled decagon
-5.times do
-	pen.move 40
-	pen.turn_right 36
-end
+		# Every move out of the fill block just draws a line
+		# Those 10 moves result in a half-filled decagon
+		5.times do
+			pen.move 40
+			pen.turn_right 36
+		end
 
 
-sheet.show
-```
+		sheet.show
+
 
 ### Animations
 You can even draw animated shapes. Here is an short example, that can be also found in the examples folder:
-```ruby
-require "edu_draw"
 
-sheet = EduDraw::Sheet.new(x: 150, y: 150)
+		require "edu_draw"
+
+		sheet = EduDraw::Sheet.new(x: 150, y: 150)
+
+		# Instead of using sheet.new_pen, now you create a new_animation_pen
+		pen = sheet.new_animation_pen(x: 75, y: 75)
 
-# Instead of using sheet.new_pen, now you create a new_animation_pen
-pen = sheet.new_animation_pen(x: 75, y: 75)
+		# Here you define what happens in the beginning of each frame
+		pen.each_frame do
+			pen.turn_right 1
+		end
 
-# Here you define what happens in the beginning of each frame
-pen.each_frame do
-	pen.turn_right 1
-end
+		# Now you define what the pen should draw each frame
+		# It is important to leave the pen in a state, where
+		# it can start drawing on the next frame, that's why
+		# the pens moves back, even though it does not draw
+		# any actual lines.
+		pen.draw_frame do
+			pen.move 50
+			pen.move -50
+		end
 
-# Now you define what the pen should draw each frame
-# It is important to leave the pen in a state, where
-# it can start drawing on the next frame, that's why
-# the pens moves back, even though it does not draw
-# any actual lines.
-pen.draw_frame do
-	pen.move 50
-	pen.move -50
-end
 
+		# You're set. Now just show the sheet as usual and enjoy
+		# the wonderfully spinning line you just drew.
+		sheet.show
 
-# You're set. No just show the sheet as usual and enjoy
-# the wonderfully spinning line you just drew.
-sheet.show
-```
 
 ## Changelog
-* 2.0.0
-  * Adds ability to fill shapes. See `examples/areas.rb`
-  * Adds ability to draw animated shapes. See `examples/animations.rb`
-  * Makes state of pen writable
-  * Greatly improves documentation
+- 2.0.0
+	- Adds ability to fill shapes. See `examples/areas.rb`
+	- Adds ability to draw animated shapes. See `examples/animations.rb`
+	- Makes state of pen writable
+	- Greatly improves documentation
 
 ## Contributing
 Feel free to contribute anything, may it be better tests, better documentation or more features. As you can see, I tried to keep the code tidy so it is appreciated if you'd do the same. Just add a pull request and we will make it work. Oh, and don't forget to have fun ;)

data/examples/animations.rb

@@ -21,6 +21,6 @@ pen.draw_frame do
 end
 
 
-# You're set. No just show the sheet as usual and enjoy
+# You're set. Now just show the sheet as usual and enjoy
 # the wonderfully spinning line you just drew.
 sheet.show

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edu_draw
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Marvin Ede
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -80,14 +80,15 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--no-private"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -100,4 +101,4 @@ signing_key:
 specification_version: 4
 summary: Offers a simple API to open a window and draw in it
 test_files: []
-has_rdoc: 
+has_rdoc: yard