added gentoo ebuilds
[libmixp.git] / README
blob8bfa5d2bcc122d5b52052e48580007a979e060af
1 Abstract
2 --------
3 libmixp is an tiny 9p2000 library which originally came from the
4 "window manager improved-improved" package [1], which provides 
5 an X11 window manager with 9P-based[2] remote control.
7 This package now provides an standalone library no dependencies
8 (besides the usual build tools ;-)), building as shared object
9 and as static/ar as well, including an pkg-config descriptor.
12 Requirements
13 ------------
14 An common GNU environment should work well. Other *nix'es may also
15 work, but not tested. Please report if you tried other targts than
16 GNU/Linux.
19 Installation
20 ------------
22 To build, simply run:
23         make
25 To install, run the following, as root, if necessary:
26         make install
28 Some parameters can be specified via environment:
30     DESTDIR      the destination prefix on installation (ie. for packaging)
31     PREFIX       (fhs-style) install dir prefix (default: /usr)
32     LIBDIR       (fhs-style) library dir        (default: $PREFIX/lib)
33     INCLUDEDIR   (fhs-style) include dir        (default: $PREFIX/include)
34     PKGCONFIGDIR directory for the .pc file     (default: $LIBDIR/pkgconfig)
35     CC           path to the C compiler (may need GNU semantics)
36     AR           path to the ar tool
37     RANLIB       path to the ranlib tool
40 Tesing libmixp
41 -------------
43 The package contains an minimalistic test client in the cmd/ subdir.
44 It's not built automatically. Just chdir to cmd/ and run make.
46 References
47 ----------
48 [1] http://www.suckless.org/
49 [2] http://www.cs.bell-labs.com/sys/man/5/INDEX.html