README

libqrencode 3.1.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

Currently the following features are not supported:
- ECI and FNC1 mode
- Micro QR Code
- 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
-----------------
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.


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
========
Some functions are THREAD UNSAFE. See qrencode.h for the details.

Carefully use the qrencode command if it is used by a web application (CGI).
For example, giving "-s" option with too large number to qrencode may cause DoS.
You should limit the parameter by your application.


LICENSING INFORMATION
=====================
Copyright (C) 2006, 2007, 2008, 2009, 2010 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


CONTACTS
========
Visit the homepage at:

http://megaui.net/fukuchi/works/qrencode/index.en.html

for new releases.

Please mail any bug reports, suggestions, comments and questions to
Kentaro Fukuchi <fukuchi@megaui.net>. Questions of license compliance
are also welcome.


ACKNOWLEDGMENTS
===============
QR Code is registered trademarks of DENSO WAVE INCORPORATED in JAPAN and other
countries.

Reed-Solomon code 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
Shigeyuki Hirai, Paul Janssens, wangsai, Gavan Fantom - bug report / suggestion