README
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 libdmtx README file (all platforms)
6
7This summary of the libdmtx package applies generally to all
8platforms. For instructions regarding your specific platform,
9also see the README.xxx file in this directory that matches your
10system (e.g., README.linux, README.osx, etc...).
11
12
131. Introduction
14-----------------------------------------------------------------
15
16libdmtx is a software library that enables programs to read and
17write Data Matrix barcodes of the modern ECC200 variety. The
18library runs natively on several platforms and can be accessed by
19multiple languages using the libdmtx language wrappers. The
20utility programs dmtxread and dmtxwrite also provide a command
21line interface for libdmtx, and serve as a good reference for
22developers writing their own libdmtx-enabled programs.
23
24This package (libdmtx) contains only the core library, and is
25distributed under a Simplified BSD license with an alternate
26waiver option. See the LICENSE file in the main project directory
27for full terms of use and distribution.
28
29The non-library components related to libdmtx are available as
30separate downloads, and are distributed under a different license
31(typically LGPLv2). Please contact support@dragonflylogic.com if
32you require clarification on licensing. It's not complicated, but
33it's important to us that all license terms are respected (not
34just ours).
35
36
372. Project Components
38-----------------------------------------------------------------
39
40The libdmtx project serves a diverse audience and contains many
41components -- some of which may not be useful to you. Components
42fall into one of four categories:
43
44 Description Package Audience
45 ----------------- ------------- ----------------------
46 Core library libdmtx libdmtx programs
47 Test programs libdmtx libdmtx developers
48 Utility programs dmtx-utils Shell and command line
49 Language Wrappers dmtx-wrappers Non-C/C++ developers
50
51
523. Installation
53-----------------------------------------------------------------
54
55libdmtx uses GNU Autotools so installation should be familiar to
56free software veterans. If your platform cannot easily run the
57Autotools scripts, refer to the appropriate platform-specific
58README.xxx located in this directory for alternate instructions.
59
60In theory the following 3 steps would build and install libdmtx
61on your system:
62
63 $ ./configure
64 $ make
65 $ sudo make install
66
67However, you may need to install additional software or make
68other changes for these steps to work properly. The details below
69will help to address errors and/or customize beyond the defaults.
70
71Problems with "configure" step
72----------------------------------------
73If you obtained libdmtx from Git you may have received an error
74like "./configure: No such file or directory". Run this command
75before trying again:
76
77 $ ./autogen.sh
78
79The autogen.sh command requires autoconf, automake, libtool, and
80pkgconfig to be installed on your system.
81
82The configure script also offers many options for customizing the
83build process, described in detail by running:
84
85 $ ./configure --help
86
87Problems with "make" step
88----------------------------------------
89Errors encountered during the "make" step are often a result of
90missing software dependencies. Install any missing software
91mentioned in the error message(s) and try again.
92
93Problems with "sudo make install" step
94----------------------------------------
95If the 'sudo' command is not configured on your system, you can
96alternatively yell "Yeeehaww!" as you log in as root and run it
97like this:
98
99 # make install
100
101And finally...
102----------------------------------------
103If you want to verify that everything is working properly you can
104optionally build the test programs:
105
106 $ make check
107
108This command will not perform any tests, but will build the
109programs that contain test logic: multi_test, rotate_test,
110simple_test, and unit_test.
111
112Note: multi_test and rotate_test contain extra dependencies due
113to their graphical nature, and are not terribly useful unless you
114need to test the library's internals.
115
116
1175. Contact
118-----------------------------------------------------------------
119
120Project website: www.libdmtx.org
121Documentation wiki: libdmtx.wikidot.com
122SourceForge.net page: www.sourceforge.net/projects/libdmtx
123OhLoh.net page: www.ohloh.net/projects/libdmtx
124Open mailing list: libdmtx-open_discussion@lists.sourceforge.net
125Professional support: www.dragonflylogic.com/products
126
127
1286. This Document
129-----------------------------------------------------------------
130
131This document is derived from the wiki page located at:
132
133 http://libdmtx.wikidot.com/general-instructions
134
135If you find an error or have additional helpful information,
136please edit the wiki directly with your updates.
137
README.cygwin
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 libdmtx README file (Cygwin)
6
7This README.cygwin file contains information on installing and
8using libdmtx on Windows in a Cygwin environment. The general
9README file, also found in this directory, contains a high level
10summary of libdmtx and its components.
11
12
131. Installing libdmtx on Windows using Cygwin
14-----------------------------------------------------------------
15
16libdmtx can be installed on Cygwin using the instructions
17provided in the general README file. However, please see below
18for additional details that might benefit users on this platform.
19
20
212. Dependencies
22-----------------------------------------------------------------
23
24The following packages must be installed to compile libdmtx on
25Cygwin:
26
27 * gcc
28 * make
29 * automake
30 * pkg-config
31
32Also, if libdmtx was obtained from Git:
33
34 * autoconf
35 * libtool
36
37
383. This Document
39-----------------------------------------------------------------
40
41This document is derived from the wiki page located at:
42
43 http://libdmtx.wikidot.com/libdmtx-on-windows-using-cygwin
44
45If you find an error or have additional helpful information,
46please edit the wiki directly with your updates.
47
README.freebsd
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 libdmtx README file (FreeBSD)
6
7This README.freebsd file contains information on installing and
8using libdmtx on FreeBSD. The general README file, also found in
9this directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing libdmtx on FreeBSD
14-----------------------------------------------------------------
15
16libdmtx can be installed on FreeBSD using the instructions
17provided in the general README file. However, please read below
18for additional details that might benefit users on this platform.
19
20
212. Running configure
22-----------------------------------------------------------------
23
24FreeBSD users may need to export the CPPFLAGS and LDFLAGS
25variables as follows before running configure:
26
27 $ export CPPFLAGS=-I/usr/local/include
28 $ export LDFLAGS=-L/usr/local/lib
29 $ ./configure
30 $ make
31 $ sudo make install
32
33
343. This Document
35-----------------------------------------------------------------
36
37This document is derived from the wiki page located at:
38
39 http://libdmtx.wikidot.com/libdmtx-on-freebsd
40
41If you find an error or have additional helpful information,
42please edit the wiki directly with your updates.
43
README.linux
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 libdmtx README file (GNU/Linux)
6
7This README.linux file contains information on installing and
8using libdmtx on GNU/Linux. The general README file, also found
9in this directory, contains a high level summary of libdmtx and
10its components.
11
12
131. Installing libdmtx on GNU/Linux
14-----------------------------------------------------------------
15
16libdmtx can be installed on Linux using the instructions provided
17in the general README file. However, please see below for
18additional details that might benefit users on this platform.
19
20
212. Pre-Compiled Binaries
22-----------------------------------------------------------------
23
24Many Linux distributions offer pre-compiled libdmtx binaries in
25their package repositories. This can be a real time saver if you
26aren't required to build from source for other reasons.
27
28Go to http://www.dragonflylogic.com/downloads for a list of all
29download options available on your system.
30
31
323. This Document
33-----------------------------------------------------------------
34
35This document is derived from the wiki page located at:
36
37 http://libdmtx.wikidot.com/libdmtx-on-gnu-linux
38
39If you find an error or have additional helpful information,
40please edit the wiki directly with your updates.
41
README.mingw
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 libdmtx README file (MinGW)
6
7This README.mingw file contains information on installing and
8using libdmtx using MinGW. The general README file, also found in
9this directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing libdmtx on Windows using MinGW and MSYS
14-----------------------------------------------------------------
15
16libdmtx can be installed on MinGW using the instructions provided
17in the general README file. However, please see below for
18additional details that might benefit users on this platform.
19
20
212. Installing MinGW and MSYS
22-----------------------------------------------------------------
23
24If you haven't done so already, first install MinGW, MSYS, and
25all recommended updates to your Windows system. Instructions for
26doing this are provided here:
27
28 http://www.mingw.org/wiki/msys
29
30
313. Building and installing the core library
32-----------------------------------------------------------------
33
34To install libdmtx, download and unpack the libdmtx source to
35your MSYS folder. If you accepted the installation defaults this
36will be C:\msys\1.0.
37
38Open the MSYS shell and run the following:
39
40 $ ./configure
41 $ make
42 $ sudo make install
43
44Go to folder .libs:
45
46 $ cd .libs
47 $ ls
48
49Now you should see following output:
50
51 libdmtx.a libdmtx.la libdmtx.lai libdmtx_la-dmtx.o
52
53Finally run:
54
55 $ gcc -shared -o dmtx.dll libdmtx_la-dmtx.o -Wl,--out-implib,libdmtx.a
56
57Now you should have working dmtx.dll in the folder .libs.
58
59
604. This Document
61-----------------------------------------------------------------
62
63This document is derived from the wiki page located at:
64
65 http://libdmtx.wikidot.com/libdmtx-on-windows-using-mingw
66
67If you find an error or have additional helpful information,
68please edit the wiki directly with your updates.
69
README.osx
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 libdmtx README file (Mac OS X)
6
7This README.osx file contains information on installing and using
8libdmtx on Mac OS X. The general README file, also found in this
9directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing libdmtx on Mac OS X
14-----------------------------------------------------------------
15
16libdmtx can be installed on OS X using the instructions provided
17in the general README file. However, please see below for
18additional details that might benefit users on this platform.
19
20
212. Universal Binaries
22-----------------------------------------------------------------
23
24You can tweak configure's parameters to build an Universal Binary
25version of the library. Recommendations are provided at:
26
27 http://developer.apple.com/technotes/tn2005/tn2137.html
28
29
303. Dependencies
31-----------------------------------------------------------------
32
33Compiling from Git requires a working autoconf/pkg-config setup:
34
35 * autoconf, automake, libtool, and pkgconfig are required to
36 generate the configure script. These packages are available
37 from MacPorts.
38
39 * You may run into issues if you mix the autotools packages in
40 MacPorts with the ones installed from Xcode Tools. Make sure
41 /opt/local/bin appears before /usr/bin in your $PATH.
42
43
444. This Document
45-----------------------------------------------------------------
46
47This document is derived from the wiki page located at:
48
49 http://libdmtx.wikidot.com/libdmtx-on-mac-os-x
50
51If you find an error or have additional helpful information,
52please edit the wiki directly with your updates.
53
README.unix
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 libdmtx README file (Unix)
6
7This README.unix file contains information on installing and
8using libdmtx on Unix. The general README file, also found in
9this directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing libdmtx on Unix
14-----------------------------------------------------------------
15
16libdmtx can be installed on Unix using the instructions provided
17in the general README file. However, please see below for
18additional details that might benefit users on this platform.
19
20
212. Known Issues
22-----------------------------------------------------------------
23
24libdmtx is known to work on the following commercial Unix
25versions:
26
27 * AIX
28 * HP-UX
29 * Solaris
30
31However, building libdmtx from source on these operating systems
32can be tricky due to their non-GNU conventions. Users may wish to
33evaluate the trial binaries available at:
34
35 http://www.dragonflylogic.com/downloads
36
37
383. This Document
39-----------------------------------------------------------------
40
41This document is derived from the wiki page located at:
42
43 http://libdmtx.wikidot.com/libdmtx-on-unix
44
45If you find an error or have additional helpful information,
46please edit the wiki directly with your updates.
47