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