mirrors/zint
2
0
Fork 0
mirror of https://github.com/zint/zint synced 2024-11-16 20:57:25 +13:00
Code Issues Actions Packages Projects Releases Wiki Activity

Make the docs fit into 80 columns

Browse Source 
Patch 5 of 7 from "Ismael Luceno" <ismael.luceno@gmail.com>
This commit is contained in:
Robin Stuart 2010-09-14 11:29:45 +01:00
parent 35c7a6ea30
commit ba7915c356
3 changed files with 99 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
INSTALL
View File

@ -1,14 +1,15 @@
****************************************************************************** **********************************************************************
* PLEASE NOTE: This is just a simple guide to getting Zint working. * * PLEASE NOTE: This is just a simple guide to getting Zint working. *
* More complete documentation is available from the project website: * * More complete documentation is available from the project website: *
* >>> http://www.zint.org.uk <<< * * >>> http://www.zint.org.uk <<< *
****************************************************************************** **********************************************************************
The easiest way to configure compilation is to take advantage of the CMake utilities. You will The easiest way to configure compilation is to take advantage of the CMake
need to install CMake first. If no Qt libraries are installed then CMake will not attempt to utilities. You will need to install CMake first. If no Qt libraries are
build the Zint Barcode Studio GUI. Similarly if libpng is not detected then CMake will not attempt installed then CMake will not attempt to build the Zint Barcode Studio
to compile PNG image support. This method is recommened in most cases, the notable exception GUI. Similarly if libpng is not detected then CMake will not attempt to
being MinGW. compile PNG image support. This method is recommened in most cases, the
notable exception being MinGW.
Once CMake is installed follow these steps: Once CMake is installed follow these steps:
@ -17,22 +18,24 @@ Once CMake is installed follow these steps:
make make
make install make install
The command line program can be accessed by typing The command line program can be accessed by typing:
zint {options} -d {data} zint {options} -d {data}
Notice that the data needs to be entered after all other options. Any options given after the Notice that the data needs to be entered after all other options. Any options
data will be ignored. The GUI can be accessed by typing given after the data will be ignored. The GUI can be accessed by typing:
zint-qt zint-qt
The MakeFile Method: The MakeFile Method:
MakeFiles are provided for some systems although this method is now deprecated. It compiles MakeFiles are provided for some systems although this method is now
and installs the library and CLI only. If you have installed Zint using this method before please deprecated. It compiles and installs the library and CLI only. If you have
note that the binaries will now install to a different location than version 2.3.0 or earlier installed Zint using this method before please note that the binaries will
(/usr/bin rather than /usr/local/bin and /usr/lib rather than /usr/local/lib). This makes now install to a different location than version 2.3.0 or earlier (/usr/bin
installation easier on Red Hat based systems (RHEL, CentOS, Fedora etc.) and on BSD-like systems rather than /usr/local/bin and /usr/lib rather than /usr/local/lib). This
(FreeBSD, OpenBSD etc.) and is more correctly in line with the LSB. makes installation easier on Red Hat based systems (RHEL, CentOS, Fedora
etc.) and on BSD-like systems (FreeBSD, OpenBSD etc.) and is more correctly
in line with the LSB.
*** UNINSTALL ANY PREVIOUS VERSION OF ZINT BEFORE USING THIS METHOD *** *** UNINSTALL ANY PREVIOUS VERSION OF ZINT BEFORE USING THIS METHOD ***
@ -41,16 +44,17 @@ To compile using this method simply run:
make make
make install make install
If compiling on MinGW substitute the Makefile.mingw files for the default Makefiles in both the If compiling on MinGW substitute the Makefile.mingw files for the default
/frontend and /backend folders. Makefiles in both the /frontend and /backend folders.
MS Windows: MS Windows:
Compiling on Cygwin and MinGW are covered above. Compiling with MS Visual Studio is more involved! Compiling on Cygwin and MinGW are covered above. Compiling with MS Visual
Full instructions are currently not ready for publication but will be placed on the project website Studio is more involved! Full instructions are currently not ready for
as soon as possible. publication but will be placed on the project website as soon as possible.
Mac OSX: Mac OSX:
Efforts are currently under way to ease compiling on OSX using the CMake method. It may be possible Efforts are currently under way to ease compiling on OSX using the CMake
to compile Zint using methods similar to those given above, but this has not been thoroughly tested method. It may be possible to compile Zint using methods similar to those
yet. If you have any success with compiling Zint on OSX then please get in touch. An install binary given above, but this has not been thoroughly tested yet. If you have any
for OSX is also in development. success with compiling Zint on OSX then please get in touch. An install
binary for OSX is also in development.

88
README
View File

@ -1,82 +1,94 @@
Zint and libzint Zint and libzint
---------------- ----------------
Zint is a suite of programs to allow easy encoding of data in any of the wide range of public domain Zint is a suite of programs to allow easy encoding of data in any of the
barcode standards and to allow integration of this capability into your own programs. wide range of public domain barcode standards and to allow integration of
this capability into your own programs.
Zint is able to encode data in the following formats: Zint is able to encode data in the following formats:
Code 11, Standard Code 2 of 5, IATA Code 2 of 5, Industrial Code 2 of 5, Interleaved Code 2 of 5, Code 11, Standard Code 2 of 5, IATA Code 2 of 5, Industrial Code 2 of 5,
Code 2 of 5 Data Logic, ITF-14, Deutche Post Leitcode, Deutche Post Identcode, UPC-A, UPC-E, EAN-2, Interleaved Code 2 of 5, Code 2 of 5 Data Logic, ITF-14, Deutche Post
EAN-5, EAN-8, EAN-13, UK Plessey, MSI Plessey, Telepen Alpha, Telepen Numeric, Code 39, Leitcode, Deutche Post Identcode, UPC-A, UPC-E, EAN-2, EAN-5, EAN-8,
Extended Code 39, Code 93, PZN, Code 23, LOGMARS, Codabar, Pharmacode, Code 128, EAN-128, NVE-18, EAN-13, UK Plessey, MSI Plessey, Telepen Alpha, Telepen Numeric, Code 39,
Code 16k, PDF417, MicroPDF417, Two-Track Pharmacode, PostNet, PLANET, Australia Post 4-State Symbols, Extended Code 39, Code 93, PZN, Code 23, LOGMARS, Codabar, Pharmacode, Code
RM4SCC, USPS OneCode, GS1 DataBar, DataBar-14, DataBar Limited, DataBar Extended, DataBar Stacked, 128, EAN-128, NVE-18, Code 16k, PDF417, MicroPDF417, Two-Track Pharmacode,
Composite Symbology, Data Matrix, QR Code, Maxicode, Aztec Code, EAN-13, Micro QR, PostNet, PLANET, Australia Post 4-State Symbols, RM4SCC, USPS OneCode, GS1
Korea Post Barcode, HIBC Code 128, HIBC Code 39, HIBC Data Matrix, HIBC PDF417, HIBC MicroPDF417, DataBar, DataBar-14, DataBar Limited, DataBar Extended, DataBar Stacked,
HIBC QR Code, HIBC Aztec Code, Japanese Postal Code, Code 49, Channel Code, Code One, Grid Matrix, Composite Symbology, Data Matrix, QR Code, Maxicode, Aztec Code, EAN-13,
FIM and Flattermarken. Micro QR, Korea Post Barcode, HIBC Code 128, HIBC Code 39, HIBC Data Matrix,
HIBC PDF417, HIBC MicroPDF417, HIBC QR Code, HIBC Aztec Code, Japanese Postal
Code, Code 49, Channel Code, Code One, Grid Matrix, FIM and Flattermarken.
PROJECT STATUS PROJECT STATUS
-------------- --------------
Version 2.3.0: Version 2.3.0:
This release features a complete rebuild of QR Code and Micro QR Code functionality which now: This release features a complete rebuild of QR Code and Micro QR Code
functionality which now:
* Automatically detects and adjusts to Japanese characters * Automatically detects and adjusts to Japanese characters
* Supports GS1 encoding * Supports GS1 encoding
* Does not require the qrencode library. * Does not require the qrencode library.
Also new in this release is Grid Matrix support which similarly supports Chinese character encoding. Also new in this release is Grid Matrix support which similarly supports
Chinese character encoding.
Version 2.3.1: Version 2.3.1:
Correction of some minor bugs in Code 128 and Data Matrix, addition of --notext option to CLI and Correction of some minor bugs in Code 128 and Data Matrix, addition of
better operation of --scale option which now scales human readable text and MaxiCode. --notext option to CLI and better operation of --scale option which now
scales human readable text and MaxiCode.
SPECIAL NOTE: Codablock-F has now been REMOVED from this project because of problems implimenting SPECIAL NOTE: Codablock-F has now been REMOVED from this project because of
this standard. For full details see the project website. problems implimenting this standard. For full details see the project website.
Version 2.3.2: Version 2.3.2:
More bug corrections including important corrections to RSS Expanded, Maxicode and ISBN. More bug corrections including important corrections to RSS Expanded,
Maxicode and ISBN.
Version 2.4: Version 2.4:
Simplified GUI. Addition of "render" functions provides an API for glabels. Corrections to 4-state codes. Simplified GUI. Addition of "render" functions provides an API for
Simplification in QR code. Added --dump option. glabels. Corrections to 4-state codes. Simplification in QR code. Added
--dump option.
CONTACT ME CONTACT ME
---------- ----------
The home of libzint is: The home of libzint is:
http://www.sourceforge.net/projects/zint <http://www.sourceforge.net/projects/zint>
and the home for Zint documentation is: and the home for Zint documentation is:
http://www.zint.org.uk <http://www.zint.org.uk>
For feature requests or bug reports please join the mailing list at For feature requests or bug reports please join the mailing list at
https://lists.sourceforge.net/lists/listinfo/zint-barcode <https://lists.sourceforge.net/lists/listinfo/zint-barcode>
or send an e-mail to or send an e-mail to
zint-barcode@lists.sourceforge.net <zint-barcode@lists.sourceforge.net>
BEFORE POSTING TO THIS LIST BEFORE POSTING TO THIS LIST
--------------------------- ---------------------------
Please note the following points... Please note the following points...
* You do not need to join the list to post messages, although joining the list will usually * You do not need to join the list to post messages, although joining
mean your request is answered more promptly. the list will usually mean your request is answered more promptly.
* Zint is primarily developed for Linux. If you are using another platform then we will be * Zint is primarily developed for Linux. If you are using another platform
less able to help you, although we will do so if we can. We cannot provide support for then we will be less able to help you, although we will do so if we can.
commercial packages such as MS Office or Crystal Reports. We cannot provide support for commercial packages such as MS Office or
* Always ensure you are using the latest version of Zint before posting bug reports - the bug Crystal Reports.
you are reporting may have been fixed already. * Always ensure you are using the latest version of Zint before posting bug
* Please remember to state what operating system you are using and include enough information reports - the bug you are reporting may have been fixed already.
to allow us to reproduce the error - including input data if appropriate. * Please remember to state what operating system you are using and include
* Please DO NOT post messages asking for us to change the license arrangements. You will be enough information to allow us to reproduce the error - including input
ignored. If you want a barcode encoder with a different license then please look elsewhere. data if appropriate.
* Please remember that Zint is developed by volunteers - don't be surprised if we are unable * Please DO NOT post messages asking for us to change the license
to help you or if it takes a long time to answer your questions. arrangements. You will be ignored. If you want a barcode encoder with a
different license then please look elsewhere.
* Please remember that Zint is developed by volunteers - don't be surprised
if we are unable to help you or if it takes a long time to answer your
questions.
Thanks for your interest in libzint. Thanks for your interest in libzint.
Happy encoding. Happy encoding.

16
TODO
View File

@ -3,10 +3,10 @@ If you are interested in improving this package then here are a few ideas.
Backend Backend
------- -------
* Create filters for more output file formats. * Create filters for more output file formats.
* Add ECI character support to allow encoding in more languages than are covered * Add ECI character support to allow encoding in more languages than are
by the Latin-1 character set. covered by the Latin-1 character set.
* The code was developed to be easy to understand rather than efficient so may benefit * The code was developed to be easy to understand rather than efficient so may
from some memory optimisation for embedded systems. benefit from some memory optimisation for embedded systems.
GUI Frontend GUI Frontend
------------ ------------
@ -15,9 +15,9 @@ GUI Frontend
Packaging Packaging
--------- ---------
Binary packages are needed for distribution in the following formats Binary packages are needed for distribution in the following formats:
* RPMs for various Linux distros (.spec file now available thanks to Radist) * RPMs for various Linux distros (.spec file now available thanks to Radist).
* Install binaries for Mac OSX * Install binaries for Mac OSX.
Translations Translations
------------ ------------
@ -27,6 +27,6 @@ Translations
Research Research
-------- --------
The following standards would be welcomed in Zint but the full documentation has The following standards would be welcomed in Zint but the full documentation has
not yet been found. not yet been found:
* DPD Code * DPD Code
* Italian Postal Code * Italian Postal Code