1libinstaller v5.0 README
2========================
3
4$Id: README,v 1.5 2005/03/21 03:26:57 cpressey Exp $
5
6What is libinstaller?
7---------------------
8
9libinstaller is a library of support functions for the BSD Installer
10application, dfuibe_installer.
11
12What is the current state of the project?
13-----------------------------------------
14
15EXPERIMENTAL.  libinstaller's application programming interface may change at
16any time.  If you use libinstaller in a project, be prepared to chase API
17changes.  Both the API and the ABI of libinstaller 5.0 are not backwards-
18compatible with those of of previous versions.
19
20How do I build and install libinstaller?
21----------------------------------------
22
23On a BSD-based system, go into the libinstaller source directory and type:
24
25	make
26
27Once built, it can be installed by typing (as root):
28
29	make install
30
31Directions may differ for other systems.
32
33An alternative method is to build libinstaller using the ports system and
34install it using the package system.
35
36How do I use libinstaller from a program?
37-----------------------------------------
38
39libinstaller requires libdfui, which in turn requires libaura, but none
40of these are statically linked with it, so any consumers of libinstaller
41will also need to link to libaura and libdfui.
42
43You can give gcc the following sort of command line flags to tell it to
44link your program with libinstaller:
45
46	gcc foo.c -o foo -L/usr/local/lib -laura -ldfui -linstaller
47
48See the libinstaller source code for the list of available functions and
49what they do.
50