mirror of
https://github.com/troglobit/libite.git
synced 2026-11-01 13:00:33 +00:00
Update README wrt the namespace change
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
This commit is contained in:
1 parent
67a9b379ba
commit
96e023e58e
1 file changed
+27
-8
@@ -45,18 +45,31 @@ Using -lite
|
|||||||
|
|
||||||
Libite is by default installed as a library and a set of include files.
|
Libite is by default installed as a library and a set of include files.
|
||||||
To prevent clashing with include files of the same name `-lite` employs
|
To prevent clashing with include files of the same name `-lite` employs
|
||||||
an include file namespace `lite/`, which is strongly recommended to use
|
an include file namespace `libite/`, which is strongly recommended to
|
||||||
in your applications:
|
use in your applications:
|
||||||
|
|
||||||
#include <lite/lite.h>
|
#include <libite/lite.h>
|
||||||
#include <lite/conio.h>
|
#include <libite/conio.h>
|
||||||
#include <lite/queue.h>
|
#include <libite/queue.h>
|
||||||
#include <lite/tree.h>
|
#include <libite/tree.h>
|
||||||
|
|
||||||
The output from the `pkg-config` tool holds no surprises in this regard:
|
> **Note:** prior to v2.5.0, the `lite/` namespace was used for headers,
|
||||||
|
> which is still available in the default install. This clashed with
|
||||||
|
> the headers of the LiTE library from the DirectFB project.
|
||||||
|
|
||||||
|
The output from the `pkg-config` tool holds no surprises:
|
||||||
|
|
||||||
$ pkg-config --libs --static --cflags libite
|
$ pkg-config --libs --static --cflags libite
|
||||||
-I/usr/local/include -L/usr/local/lib -lite
|
-I/usr/local/include -D_LIBITE_LITE -L/usr/local/lib -lite
|
||||||
|
|
||||||
|
Notice that `_LIBITE_LITE` is defined since v2.5.0, useful for software
|
||||||
|
that want to be able to build against headers from an older libite:
|
||||||
|
|
||||||
|
#ifdef _LIBITE_LITE
|
||||||
|
# include <libite/lite.h>
|
||||||
|
#else
|
||||||
|
# include <lite/lite.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
The prefix path `/usr/local/` shown here is only the default. Use the
|
The prefix path `/usr/local/` shown here is only the default. Use the
|
||||||
`configure` script to select a different prefix when installing libite.
|
`configure` script to select a different prefix when installing libite.
|
||||||
@@ -85,6 +98,12 @@ as a light weight utility library, these days NetBSD should also work.
|
|||||||
sudo make install-strip
|
sudo make install-strip
|
||||||
sudo ldconfig
|
sudo ldconfig
|
||||||
|
|
||||||
|
Use `./configure --without-symlink` to skip the `lite -> libite/`
|
||||||
|
compatibility symlink in the include directory. This is required for
|
||||||
|
systems with DirectFB LiTE. The default, however, is to install the
|
||||||
|
symlink to ensure compatibility with existing software that depends on
|
||||||
|
the `-lite` library headers in their previous namespace.
|
||||||
|
|
||||||
**Note:** When checking out code from GIT, use <kbd>./autogen.sh</kbd>
|
**Note:** When checking out code from GIT, use <kbd>./autogen.sh</kbd>
|
||||||
to generate a `configure` script. It is a generated file and otherwise
|
to generate a `configure` script. It is a generated file and otherwise
|
||||||
only included in released tarballs.
|
only included in released tarballs.
|
||||||
|
|||||||
Reference in new issue
Block a user