blob: e5716d6f3aaceab86914d5869e1e695c4ec60b54 [file] [log] [blame]
Nicolas Jager95c526b2016-10-20 09:47:03 -04001libqrencode 3.4.4 - QR Code encoding library
2
3GENERAL INFORMATION
4===================
5Libqrencode is a library for encoding data in a QR Code symbol, a 2D symbology
6that can be scanned by handy terminals such as a mobile phone with CCD. The
7capacity of QR Code is up to 7000 digits or 4000 characters and has high
8robustness.
9
10Libqrencode accepts a string or a list of data chunks then encodes in a QR Code
11symbol as a bitmap array. While other QR Code applications generate an image
12file, using libqrencode allows applications to render QR Code symbols from raw
13bitmap data directly. This library also contains a command-line utility outputs
14a QR Code symbol as a PNG image.
15
16
17SPECIFICATION
18=============
19Libqrencode supports QR Code model 2, described in JIS (Japanese Industrial
20Standards) X0510:2004 or ISO/IEC 18004. Most of features in the specification
21are implemented such as:
22- Numeric, alphabet, Japanese kanji (Shift-JIS) or any 8 bit code can be
23 embedded
24- Optimized encoding of a string
25- Structured-append of symbols
26- Micro QR Code (experimental)
27
28Currently the following features are not supported:
29- ECI and FNC1 mode
30- QR Code model 1 (deprecated)
31
32
33INSTALL
34=======
35
36Requirements
37------------
38Some test programs or utility tools uses SDL or PNG, but the library itself
39has no dependencies. You can skip compiling those tools if you want not to
40install programs using SDL or PNG.
41
42Compile & install
43-----------------
44Just try
45
46./configure
47make
48make install
49
50This compiles and installs the library and header file to the appropriate
51directories. By default, /usr/local/lib and /usr/local/include. You can change
52the destination directory by passing some options to the configure script.
53Run "./configure --help" to see the list of options.
54
55It also installs a binary "qrencode" to /usr/local/bin. If you want not to
56install it, give "--without-tools" option to the configure script.
57
58When you downloaded a development tree from github, it is required to run
59"autogen.sh" at first to generate configure script.
60
61
62USAGE
63=====
64Basic usages of this library are written in the header file (qrencode.h).
65You can generate a manual of the library by using Doxygen.
66
67
68WARNINGS
69========
70The library is distributed WITHOUT ANY WRRANTY.
71
72Micro QR Code support is EXPERIMENTAL.
73
74Be careful to use the command line tool (qrencode) if it is used by a web
75application (e.g. CGI script). For example, giving "-s" option with a large
76number to qrencode may cause DoS. The parameters should be checked by the
77application.
78
79
80LICENSING INFORMATION
81=====================
82Copyright (C) 2006-2012 Kentaro Fukuchi
83
84This library is free software; you can redistribute it and/or modify it under
85the terms of the GNU Lesser General Public License as published by the Free
86Software Foundation; either version 2.1 of the License, or any later version.
87
88This library is distributed in the hope that it will be useful, but WITHOUT ANY
89WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
90PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
91
92You should have received a copy of the GNU Lesser General Public License along
93with this library; if not, write to the Free Software Foundation, Inc., 51
94Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
95
96
97CONTACT
98=======
99Visit the homepage at:
100
101http://fukuchi.org/works/qrencode/
102
103for new releases. The git repository is available at:
104
105https://github.com/fukuchi/libqrencode
106
107Please mail any bug reports, suggestions, comments, and questions to:
108
109Kentaro Fukuchi <kentaro@fukuchi.org>
110
111or submit issues to:
112
113https://github.com/fukuchi/libqrencode/issues
114
115Questions of license compliance are also welcome.
116
117
118ACKNOWLEDGMENTS
119===============
120QR Code is registered trademarks of DENSO WAVE INCORPORATED in JAPAN and other
121countries.
122
123Reed-Solomon encoder is written by Phil Karn, KA9Q.
124Copyright (C) 2002, 2003, 2004, 2006 Phil Karn, KA9Q
125
126BlueDragon747 - made changes for VS 2015 compatability
127NANKI Haruo - improved lower-case characteres encoding
128Philippe Delcroix - improved mask evaluation
129Yusuke Mihara - structured-append support
130David Dahl - DPI and SVG support patch
131Adam Shepherd - bug fix patch of the mask evaluation
132Josef Eisl (zapster) - EPS support patch
133Colin (moshen) - ANSI support patch
134Ralf Ertzinger - ASCII support patch
135Yutaka Niibe (gniibe) - various bug fix patches
136Dan Storm (Repox) - SVG support patch
137Lennart Poettering (mezcalero)
138 - improved text art patch
139Yann Droneaud - improved input validation patch
140Viona - bug fix patch for string splitting
141Daniel Dörrhöfer - RLE option
142Shigeyuki Hirai, Paul Janssens, wangsai, Gavan Fantom, Matthew Baker, Rob Ryan,
143Fred Steinhaeuser, Terry Burton, chisj, vlad417, Petr, Hassan Hajji,
144Emmanuel Blot, ßlúèÇhîp, win32asm, Antenore, Yoshimichi Inoue
145 - bug report / suggestion