diff --git a/INSTALL b/INSTALL new file mode 100644 index 00000000..501f9136 --- /dev/null +++ b/INSTALL @@ -0,0 +1,56 @@ + ****************************************************************************** + * PLEASE NOTE: This is just a simple guide to getting Zint working. * + * More complete documentation is available from the project website: * + * >>> http://www.zint.org.uk <<< * + ****************************************************************************** + +The easiest way to configure compilation is to take advantage of the CMake utilities. You will +need to install CMake first. If no Qt libraries are installed then CMake will not attempt to +build the Zint Barcode Studio GUI. Similarly if libpng is not detected then CMake will not attempt +to compile PNG image support. This method is recommened in most cases, the notable exception +being MinGW. + +Once CMake is installed follow these steps: + + cd build + cmake .. + make + make install + +The command line program can be accessed by typing + + zint {options} -d {data} + +Notice that the data needs to be entered after all other options. Any options given after the +data will be ignored. The GUI can be accessed by typing + + zint-qt + +The MakeFile Method: +MakeFiles are provided for some systems although this method is now deprecated. It compiles +and installs the library and CLI only. If you have installed Zint using this method before please +note that the binaries will now install to a different location than version 2.3.0 or earlier +(/usr/bin rather than /usr/local/bin and /usr/lib rather than /usr/local/lib). This 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 *** + +To compile using this method simply run: + + make + make install + +If compiling on MinGW substitute the Makefile.mingw files for the default Makefiles in both the +/frontend and /backend folders. + +MS Windows: +Compiling on Cygwin and MinGW are covered above. Compiling with MS Visual Studio is more involved! +Full instructions are currently not ready for publication but will be placed on the project website +as soon as possible. + +Mac OSX: +Efforts are currently under way to ease compiling on OSX using the CMake method. It may be possible +to compile Zint using methods similar to those given above, but this has not been thoroughly tested +yet. If you have any success with compiling Zint on OSX then please get in touch. An install binary +for OSX is also in development. diff --git a/README b/README index 350fc16b..25294599 100644 --- a/README +++ b/README @@ -16,11 +16,6 @@ Korea Post Barcode, HIBC Code 128, HIBC Code 39, HIBC Data Matrix, HIBC PDF417, HIBC QR Code, HIBC Aztec Code, Japanese Postal Code, Code 49, Channel Code, Code One, Grid Matrix, FIM and Flattermarken. - ****************************************************************************** - * PLEASE NOTE: This is just a simple guide to getting Zint working. * - * More complete documentation is available from the project website: * - * >>> http://www.zint.org.uk <<< * - ****************************************************************************** PROJECT STATUS -------------- @@ -47,95 +42,6 @@ Version 2.4: Simplified GUI. Addition of "render" functions provides an API for glabels. Corrections to 4-state codes. Simplification in QR code. Added --dump option. -COMPILING THE CODE ------------------- -The CMake Method: -The easiest way to configure compilation is to take advantage of the CMake utilities. You will -need to install CMake first. If no Qt libraries are installed then CMake will not attempt to -build the Zint Barcode Studio GUI. Similarly if libpng is not detected then CMake will not attempt -to compile PNG image support. This method is recommened in most cases, the notable exception -being MinGW. - -Once CMake is installed follow these steps: - - cd build - cmake .. - make - make install - -The command line program can be accessed by typing - - zint {options} -d {data} - -Notice that the data needs to be entered after all other options. Any options given after the -data will be ignored. The GUI can be accessed by typing - - zint-qt - -The MakeFile Method: -MakeFiles are provided for some systems although this method is now deprecated. It compiles -and installs the library and CLI only. If you have installed Zint using this method before please -note that the binaries will now install to a different location than version 2.3.0 or earlier -(/usr/bin rather than /usr/local/bin and /usr/lib rather than /usr/local/lib). This 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 *** - -To compile using this method simply run: - - make - make install - -If compiling on MinGW substitute the Makefile.mingw files for the default Makefiles in both the -/frontend and /backend folders. - -MS Windows: -Compiling on Cygwin and MinGW are covered above. Compiling with MS Visual Studio is more involved! -Full instructions are currently not ready for publication but will be placed on the project website -as soon as possible. - -Mac OSX: -Efforts are currently under way to ease compiling on OSX using the CMake method. It may be possible -to compile Zint using methods similar to those given above, but this has not been thoroughly tested -yet. If you have any success with compiling Zint on OSX then please get in touch. An install binary -for OSX is also in development. - -THINGS TO DO ------------- -If you are interested in improving this package then here are a few ideas. - -Backend -------- - * Create filters for more output file formats. - * Add ECI character support to allow encoding in more languages than are covered - by the Latin-1 character set. - * The code was developed to be easy to understand rather than efficient so may benefit - from some memory optimisation for embedded systems. - -GUI Frontend ------------- - * Allow copying of generated barcodes to the clipboard with a "Copy" button. - * Allow dragging and dropping to external apps. - -Packaging ---------- - Binary packages are needed for distribution in the following formats - * RPMs for various Linux distros (.spec file now available thanks to Radist) - * Install binaries for Mac OSX - -Translations ------------- - Documentation is currently only in English. If you have the knowledge and the - time please consider translating into other languages. - -Research --------- - The following standards would be welcomed in Zint but the full documentation has - not yet been found. - * DPD Code - * Italian Postal Code - CONTACT ME ---------- @@ -176,6 +82,3 @@ Thanks for your interest in libzint. Happy encoding. Robin. - - - diff --git a/TODO b/TODO new file mode 100644 index 00000000..761c4a62 --- /dev/null +++ b/TODO @@ -0,0 +1,32 @@ +If you are interested in improving this package then here are a few ideas. + +Backend +------- + * Create filters for more output file formats. + * Add ECI character support to allow encoding in more languages than are covered + by the Latin-1 character set. + * The code was developed to be easy to understand rather than efficient so may benefit + from some memory optimisation for embedded systems. + +GUI Frontend +------------ + * Allow copying of generated barcodes to the clipboard with a "Copy" button. + * Allow dragging and dropping to external apps. + +Packaging +--------- + Binary packages are needed for distribution in the following formats + * RPMs for various Linux distros (.spec file now available thanks to Radist) + * Install binaries for Mac OSX + +Translations +------------ + Documentation is currently only in English. If you have the knowledge and the + time please consider translating into other languages. + +Research +-------- + The following standards would be welcomed in Zint but the full documentation has + not yet been found. + * DPD Code + * Italian Postal Code