Convert INSTALL and README to markdown

While here, be sure that all links will be pointing to the
right places.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2019-02-05 12:42:11 -02:00
parent 23675cd856
commit 65fe05b55e
4 changed files with 308 additions and 292 deletions

197
INSTALL
View File

@ -1,197 +0,0 @@
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.
The file `configure.in' is used to create `configure' by a program
called `autoconf'. You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`autoreconf -vfi && ./configure' to configure the package for
your system. If you're using `csh' on an old version of System V,
you might need to type `sh ./configure' instead to prevent `csh'
from trying to execute `configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. You can give `configure'
initial values for variables by setting them in the environment. Using
a Bourne-compatible shell, you can do that on the command line like
this:
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
Or on systems that have the `env' program, you can do it like this:
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory. After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on. Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
CPU-COMPANY-SYSTEM
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.
If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Operation Controls
==================
`configure' recognizes the following options to control how it
operates.
`--cache-file=FILE'
Use and save the results of the tests in FILE instead of
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
debugging `configure'.
`--help'
Print a summary of the options to `configure', and exit.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`--version'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`configure' also accepts some other, not widely useful, options.
Debian/Ubuntu package build
===========================
For Debian/Ubuntu, one alternative way to build ZBar is by using
pbuilder. In order to install pbuilder, see, for example:
https://wiki.ubuntu.com/PbuilderHowto
Once you have pbuilder installed and configured, you
can build a ZBar package, running the following commands as
root:
# pbuilder create --basetgz /var/cache/pbuilder/base-test.tgz
# pbuilder build --basetgz /var/cache/pbuilder/base-test.tgz ../zbar_0.20.2.dsc

199
INSTALL.md Normal file
View File

@ -0,0 +1,199 @@
Basic Installation
==================
These are generic installation instructions.
The `configure` shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile` in each directory of the package.
It may also create one or more `.h` files containing system-dependent
definitions. Finally, it creates a shell script `config.status` that
you can run in the future to recreate the current configuration, a file
`config.cache` that saves the results of its tests to speed up
reconfiguring, and a file `config.log` containing compiler output
(useful mainly for debugging `configure`).
If you need to do unusual things to compile the package, please try
to figure out how `configure` could check whether to do them, and mail
diffs or instructions to the address given in the `README` so they can
be considered for the next release. If at some point `config.cache`
contains results you don't want to keep, you may remove or edit it.
The file `configure.in` is used to create `configure` by a program
called `autoconf`. You only need `configure.in` if you want to change
it or regenerate `configure` using a newer version of `autoconf`.
The simplest way to compile this package is:
1. `cd` to the directory containing the package's source code and type
`autoreconf -vfi && ./configure` to configure the package for
your system. If you're using `csh` on an old version of System V,
you might need to type `sh ./configure` instead to prevent `csh`
from trying to execute `configure` itself.
Running `configure` takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make` to compile the package.
3. Optionally, type `make check` to run any self-tests that come with
the package.
4. Type `make install` to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean`. To also remove the
files that `configure` created (so you can compile the package for
a different kind of computer), type `make distclean`. There is
also a `make maintainer-clean` target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure` script does not know about. You can give `configure`
initial values for variables by setting them in the environment. Using
a Bourne-compatible shell, you can do that on the command line like
this:
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
Or on systems that have the `env` program, you can do it like this:
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make` that
supports the `VPATH` variable, such as GNU `make`. `cd` to the
directory where you want the object files and executables to go and run
the `configure` script. `configure` automatically checks for the
source code in the directory that `configure` is in and in `../`.
If you have to use a `make` that does not supports the `VPATH`
variable, you have to compile the package for one architecture at a time
in the source code directory. After you have installed the package for
one architecture, use `make distclean` before reconfiguring for another
architecture.
Installation Names
==================
By default, `make install` will install the package's files in
`/usr/local/bin`, `/usr/local/man`, etc. You can specify an
installation prefix other than `/usr/local` by giving `configure` the
option `--prefix=PATH`.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure` the option `--exec-prefix=PATH`, the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH` to specify different values for particular
kinds of files. Run `configure --help` for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure` the
option `--program-prefix=PREFIX` or `--program-suffix=SUFFIX`.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE` options to
`configure`, where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE` options, where PACKAGE
is something like `gnu-as` or `x` (for the X Window System). The
`README` should mention any `--enable-` and `--with-` options that the
package recognizes.
For packages that use the X Window System, `configure` can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure` options `--x-includes=DIR` and
`--x-libraries=DIR` to specify their locations.
Specifying the System Type
==========================
There may be some features `configure` can not figure out
automatically, but needs to determine by the type of host the package
will run on. Usually `configure` can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE` option. TYPE can either be a short name for the system
type, such as `sun4`, or a canonical name with three fields:
CPU-COMPANY-SYSTEM
See the file `config.sub` for the possible values of each field. If
`config.sub` isn't included in this package, then this package doesn't
need to know the host type.
If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE` option to select the type of system they will
produce code for and the `--build=TYPE` option to select the type of
system on which you are compiling the package.
Sharing Defaults
================
If you want to set default values for `configure` scripts to share,
you can create a site shell script called `config.site` that gives
default values for variables like `CC`, `cache_file`, and `prefix`.
`configure` looks for `PREFIX/share/config.site` if it exists, then
`PREFIX/etc/config.site` if it exists. Or, you can set the
`CONFIG_SITE` environment variable to the location of the site script.
A warning: not all `configure` scripts look for a site script.
Operation Controls
==================
`configure` recognizes the following options to control how it
operates.
`--cache-file=FILE`
Use and save the results of the tests in FILE instead of
`./config.cache`. Set FILE to `/dev/null` to disable caching, for
debugging `configure`.
`--help`
Print a summary of the options to `configure`, and exit.
`--quiet`
`--silent`
`-q`
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null` (any error
messages will still be shown).
`--srcdir=DIR`
Look for the package's source code in directory DIR. Usually
`configure` can determine that directory automatically.
`--version`
Print the version of Autoconf used to generate the `configure`
script, and exit.
`configure` also accepts some other, not widely useful, options.
Debian/Ubuntu package build
===========================
For Debian/Ubuntu, one alternative way to build ZBar is by using
pbuilder. In order to install pbuilder, see, for example:
https://wiki.ubuntu.com/PbuilderHowto
Once you have pbuilder installed and configured, you
can build a ZBar package, running the following commands as
root:
# pbuilder create --basetgz /var/cache/pbuilder/base-test.tgz
# pbuilder build --basetgz /var/cache/pbuilder/base-test.tgz ../zbar_0.20.2.dsc

95
README
View File

@ -1,95 +0,0 @@
ZBAR BAR CODE READER
====================
ZBar Bar Code Reader is an open source software suite for reading bar
codes from various sources, such as video streams, image files and raw
intensity sensors. It supports EAN-13/UPC-A, UPC-E, EAN-8, Code 128,
Code 39, Codabar, Interleaved 2 of 5 and QR Code. Included with the
library are basic applications for decoding captured bar code images and
using a video device (eg, webcam) as a bar code scanner. For application
developers, language bindings are included for C, C++, Python 2 and Perl
as well as GUI widgets for Qt, GTK and PyGTK 2.0.
Check the ZBar home page for the latest release, mailing lists, etc.
https://github.com/mchehab/zbar
License information can be found in 'COPYING'.
BUILDING
========
See 'INSTALL' for generic configuration and build instructions.
The scanner/decoder library itself only requires a few standard
library functions which should be avilable almost anywhere.
The zbarcam program uses the video4linux API (v4l1 or v4l2) to access
the video device. This interface is part of the linux kernel, a 2.6
kernel is recommended for full support. More information is available
at
http://www.linuxtv.org/wiki/
pkg-config is used to locate installed libraries. You should have
installed pkg-config if you need any of the remaining components.
pkg-config may be obtained from
http://pkg-config.freedesktop.org/
The zbarimg program uses ImageMagick to read image files in many
different formats. You will need at least ImageMagick version 6.2.6
if you want to scan image files. ImageMagick may be obtained from
http://www.imagemagick.org/
The Qt widget requires Qt4. You will need Qt4 if you would like to
use or develop a Qt GUI application with an integrated bar code
scanning widget. Qt4 may be obtained from
http://qt.nokia.com/products
The GTK+ widget requires GTK+-2.x. You will need GTK+ if you would
like to use or develop a GTK+ GUI application with an integrated bar
code scanning widget. GTK+ may be obtained from
http://www.gtk.org/
The PyGTK 2.0 wrapper for the GTK+ widget requires Python 2, PyGTK.
You will need both if you would like to use or develop a PyGTK GUI
application with an integrated bar code scanning widget. PyGTK may be
obtained from
http://www.pygtk.org/
The Python bindings require Python 2. You will need Python and PIL
if you would like to scan images or video directly using Python.
Python is available from
http://python.org/
The Perl bindings require Perl (version?). You will need Perl if you
would like to scan images or video directly using Perl. Perl is
available from
http://www.perl.org/
If required libraries are not available you may disable building for
the corresponding component using configure (see configure --help).
The Perl bindings must be built separately after installing the
library. see
perl/README
RUNNING
=======
'make install' will install the library and application programs. Run
'zbarcam' to start the video scanner. use 'zbarimg barcode.jpg' to
decode a saved image file. Check the manual to find specific options
for each program.
REPORTING BUGS
==============
Bugs can be reported on the sourceforge project page
http://www.sourceforge.net/projects/zbar/
Please include the ZBar version number and a detailed description of
the problem. You'll probably have better luck if you're also familiar
with the concepts from:
http://www.catb.org/~esr/faqs/smart-questions.html

109
README.md Normal file
View File

@ -0,0 +1,109 @@
ZBAR BAR CODE READER
====================
ZBar Bar Code Reader is an open source software suite for reading bar
codes from various sources, such as video streams, image files and raw
intensity sensors. It supports EAN-13/UPC-A, UPC-E, EAN-8, Code 128,
Code 93, Code 39, Codabar, Interleaved 2 of 5, QR Code and SQ Code.
Included with the library are basic applications for decoding captured bar
code images and using a video device (eg, webcam) as a bar code scanner.
For application developers, language bindings are included for C, C++,
Python 2 and Perl as well as GUI widgets for Qt, GTK and PyGTK 2.0.
Check the ZBar home page for the latest release, mailing lists, etc.:
- <https://github.com/mchehab/zbar>
License information can be found in `COPYING`.
BUILDING
========
See `INSTALL.md` for generic configuration and build instructions.
The scanner/decoder library itself only requires a few standard
library functions which should be avilable almost anywhere.
The zbarcam program uses the video4linux API (v4l1 or v4l2) to access
the video device. This interface is part of the linux kernel, a 3.16
kernel or upper is recommended for full support. More information is
available at:
- <http://www.linuxtv.org/wiki/>
`pkg-config` is used to locate installed libraries. You should have
installed `pkg-config` if you need any of the remaining components.
pkg-config may be obtained from:
- <http://pkg-config.freedesktop.org/>
The `zbarimg` program uses `ImageMagick` to read image files in many
different formats. You will need at least `ImageMagick` version 6.2.6
if you want to scan image files. `ImageMagick` may be obtained from:
- <http://www.imagemagick.org/>
The Qt widget requires Qt4 or Qt5. You will need Qt if you would like to
use or develop a Qt GUI application with an integrated bar code
scanning widget. Qt4 may be obtained from:
- <https://www.qt.io/>
The GTK+ widget requires GTK+-2.x. You will need GTK+ if you would
like to use or develop a GTK+ GUI application with an integrated bar
code scanning widget. GTK+ may be obtained from:
- <http://www.gtk.org/>
The PyGTK 2.0 wrapper for the GTK+ widget requires Python 2, PyGTK.
You will need both if you would like to use or develop a PyGTK GUI
application with an integrated bar code scanning widget. PyGTK may be
obtained from:
- <http://www.pygtk.org/>
The Python bindings require Python 2. You will need Python and PIL
if you would like to scan images or video directly using Python.
Python is available from:
- <http://python.org/>
The Perl bindings require Perl (version?). You will need Perl if you
would like to scan images or video directly using Perl. Perl is
available from:
- <http://www.perl.org/>
If required libraries are not available you may disable building for
the corresponding component using configure (see configure --help).
The Perl bindings must be built separately after installing the
library. see:
- `perl/README`
RUNNING
=======
`make install` will install the library and application programs. Run
`zbarcam-qt` or `zbarcam` to start the video scanner. Use `zbarimg <file>`
to decode a saved image file.
Check the manual to find specific options for each program.
REPORTING BUGS
==============
Bugs can be reported on the project page:
- <https://github.com/mchehab/zbar>
Please include the ZBar version number and a detailed description of
the problem. You'll probably have better luck if you're also familiar
with the concepts from:
- <http://www.catb.org/~esr/faqs/smart-questions.html>