Skip to content

nschlia/libdvdetect

Repository files navigation

WHAT IS libdvdetect

DOCUMENTATION

The API documentation can be consulted on the project homepage:

    https://www.dvdetect.de/

It is possible to create your own copy of this documentation in both
HTML and LaTeX format using the doxygen program (http://doxygen.org).
If you have doxygen installed, execute the following command in the
doc/ directory:

    doxygen doxygen.conf

This will create two subdirectories html/ and latex/ in which you will
find the documentation in the respective formats.

COMPILING

To compile. do the usual "configure" and then "make".

For windows, you should get GNU MSYS which provides the set of UNIX 
tools required, as well as the GNU compiler (mingw):

http://www.mingw.org/wiki/MSYS

It should be possible to compile everything with M$ Visual C, but you 
still need to do configure beforehand to get some required headers like 
config.h and version.h.

Tested environments:

* Suse 12.2
* Suse 11.4
* Debian (Debian 2.6.32-48squeeze1)
* Debian (Raspbian 4.9.2-10) ARM
* Debian (Debian 4.8.4-1)
* Windows 7 (using GNU MSYS)
* Windows Cygwin

See INSTALL for instructions.

CHARSETS

Internally the library uses utf-8 only. This is used to communicate with
the web server (all xml documents are utf-8 encoded) and on the server
side for the database. If you call any text oriented function of the API,
be prepared that it returns utf-8 code or expects texts in that coding.

If you want to support international character sets (cyrillic, Japanese,
sanskrit - whatever) you must be able to handle utf-8.

WARNING

THIS IS AN EARLY STAGE BETA WHICH WILL UNDERGO A LOT OF CHANGES ON THE
RELEASE. PLEASE REFRAIN FROM DOING "make install" FOR NOW!

This could distribute files which may be in the way for later releases
or cause other disturbances, because this part of make has not been
undergone testing as of yet

INFORMATION

The primary source of information for this project is:

    https://github.com/nschlia/libdvdetect

Bugs and feature requests can be submitted on the project
homepage:

    https://github.com/nschlia/libdvdetect/issues

Or they can be send directly to me:
    Norbert Schlia <mailto:nschlia@dvdetect.de>

Feel free to clone the project on github and provide your own
changes!