public
Description: A Ruby library that encodes QR Codes
Homepage: http://whomwah.github.com/rqrcode/
Clone URL: git://github.com/whomwah/rqrcode.git
Click here to lend your support to: rqrcode and make a donation at www.pledgie.com !
whomwah (author)
Sun Mar 15 08:16:08 -0700 2009
commit  e88f3f168b7e3872cccf32bcffc3e389a963b454
tree    5c80169b67f05823fdae2902117c010ea8a9aec6
parent  790b14bf5208455fc8bf4a60466a8cf7628c92bd
rqrcode / README
100644 99 lines (73 sloc) 2.4 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
== rQRCode, Encode QRCodes
 
rQRCode is a library for encoding QR Codes in Ruby. It has a simple interface with all the standard qrcode options. It was adapted from the Javascript library by Kazuhiko Arase.
 
RubyForge Project Page http://rubyforge.org/projects/rqrcode/
 
== An Overview
 
Let's clear up some rQRCode stuff.
 
 # rQRCode is a *standalone library*. It requires no other libraries. Just Ruby!
 # It is an encoding library. You can't decode QR codes with it.
 # The interface is simple and assumes you just want to encode a string into a QR code
 # QR code is trademarked by Denso Wave inc
 
== Resources
 
wikipedia:: http://en.wikipedia.org/wiki/QR_Code
Denso-Wave website:: http://www.denso-wave.com/qrcode/index-e.html
kaywa:: http://qrcode.kaywa.com
 
 
== Installing
 
You may get the latest stable version from Rubyforge.
 
  $ gem install rqrcode
 
You can also get the source from http://github.com/whomwah/rqrcode/tree/master
 
  $ git clone git://github.com/whomwah/rqrcode.git
 
 
=== Loading rQRCode Itself
 
You have installed the gem already, yeah?
 
 require 'rubygems'
 require 'rqrcode'
 
=== Simple QRCode generation to screen
 
 qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
 puts qr.to_s
 #
 # Prints:
 # xxxxxxx x x x x x xx xxxxxxx
 # x x xxx xxxxxx xxx x x
 # x xxx x xxxxx x xx x xxx x
 # ... etc
 
=== Simple QRCode generation to view (RubyOnRails)
 
<b>Controller:</b>
 @qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
 
<b>View: (minimal styling added)</b>
 <style type="text/css">
 table {
   border-width: 0;
   border-style: none;
   border-color: #0000ff;
   border-collapse: collapse;
 }
 td {
   border-width: 0;
   border-style: none;
   border-color: #0000ff;
   border-collapse: collapse;
   padding: 0;
   margin: 0;
   width: 10px;
   height: 10px;
 }
 td.black { background-color: #000; }
 td.white { background-color: #fff; }
 </style>
 
 <table>
 <% @qr.modules.each_index do |x| %>
   <tr>
   <% @qr.modules.each_index do |y| %>
    <% if @qr.is_dark(x,y) %>
     <td class="black"/>
    <% else %>
     <td class="white"/>
    <% end %>
   <% end %>
   </tr>
 <% end %>
 </table>
 
== Contact
 
Author:: Duncan Robertson
Email:: duncan@whomwah.com
Home Page:: http://whomwah.com
License:: MIT Licence (http://www.opensource.org/licenses/mit-license.html)