libqrencode 3.3.1 - QR Code encoding library GENERAL INFORMATION =================== Libqrencode is a library for encoding data in a QR Code symbol, a kind of 2D symbology that can be scanned by handy terminals such as a mobile phone with CCD. The capacity of QR Code is up to 7000 digits or 4000 characters, and has high robustness. Libqrencode accepts a string or a list of data chunks then encodes in a QR Code symbol as a bitmap array. While other QR Code applications generate an image file, using libqrencode allows applications to render QR Code symbols from raw bitmap data directly. This library also contains a command-line utility outputs a QR Code symbol as a PNG image. It will help light-weight CGI programs. SPECIFICATION ============= Libqrencode supports QR Code model 2, described in JIS (Japanese Industrial Standards) X0510:2004 or ISO/IEC 18004. Most of features in the specification are implemented such as: - Numeric, alphabet, Japanese kanji (Shift-JIS) or any 8 bit code can be embedded - Optimized encoding of a string - Structured-append of symbols - Micro QR Code (experimental) Currently the following features are not supported: - ECI and FNC1 mode - QR Code model 1 (deprecated) INSTALL ======= Requirements ------------ Some test programs or utility tools uses SDL or PNG, but the library itself has no dependencies. You can skip compiling those tools if you want not to install programs using SDL or PNG. Compile & install ----------------- a) ... using Autotools Just try ./configure make make install This compiles and installs the library and header file to the appropriate directories. By default, /usr/local/lib and /usr/local/include. You can change the destination directory by passing some options to the configure script. Run "./configure --help" to see the list of options. It also installs a binary "qrencode" to /usr/local/bin. If you want not to install it, give "--without-tools" option to the configure script. b) ... using CMake For an out-of-source build create a separate build directory which within to carry out the compile mkdir build cd build cmake .. make install By default library and header files are installed into /usr/local/lib and /usr/local/include. You can change the destination directory by providing the appropriate option during the configuration step, i.e. cmake -DCMAKE_INSTALL_PREFIX=<prefix> .. Testing ------- A public dashboard for libqrencode is hosted on my.cdash.org. CDash (www.cdash.org) is an open-source web-based server for continuous integration. CDash aggregates, analyzes and displays the results of software testing processes submitted from clients located around the world. Developers depend on CDash to convey the state of a software system, and to continually improve its quality. In order to submit the results of an experimental build, simply run make Experimental This will trigger CTest to configure and build the project, before running the tests defined therein - the collected results then will be submitted to CDash for visualization and analysis. USAGE ===== Basic usages of this library are written in the header file (qrencode.h). You can generate a manual of the library by using Doxygen. WARNINGS ======== The library is distributed WITHOUT ANY WRRANTY. Micro QR Code support is EXPERIMENTAL. Be careful to use the command line tool (qrencode) if it is used by a web application (e.g. CGI script). For example, giving "-s" option with a large number to qrencode may cause DoS. The parameters should be checked by the application. LICENSING INFORMATION ===================== Copyright (C) 2006-2012 Kentaro Fukuchi This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA CONTACT ======= Visit the homepage at: http://fukuchi.org/works/qrencode/ for new releases. The git repository is available at: https://github.com/fukuchi/libqrencode Please mail any bug reports, suggestions, comments and questions to: Kentaro Fukuchi <kentaro@fukuchi.org> or submit issues to: https://github.com/fukuchi/libqrencode/issues Questions of license compliance are also welcome. ACKNOWLEDGMENTS =============== QR Code is registered trademarks of DENSO WAVE INCORPORATED in JAPAN and other countries. Reed-Solomon encoder is written by Phil Karn, KA9Q. Copyright (C) 2002, 2003, 2004, 2006 Phil Karn, KA9Q NANKI Haruo - improved lower-case characteres encoding Philippe Delcroix - improved mask evaluation Yusuke Mihara - structured-append support David Dahl - DPI patch Adam Shepherd - bug fix patch of the mask evaluation Josef Eisl (zapster) - EPS support patch Colin (moshen) - ANSI support patch Ralf Ertzinger - ASCII support patch Yutaka Niibe (gniibe) - various bug fix patches Dan Strom (Repox) - SVG support patch Shigeyuki Hirai, Paul Janssens, wangsai, Gavan Fantom, Matthew Baker, Rob Ryan, Fred Steinhaeuser - bug report / suggestion