README
1Libnsutils - NetSurf utility functions
2======================================
3
4Overview
5--------
6
7 Libnsutils provides a small number of useful utility routines which
8 require platform-specific implementations.
9
10Requirements
11------------
12
13 Libnsutils requires the following tools:
14
15 + A C99 capable C compiler
16 + GNU make or compatible
17 + Pkg-config
18
19Compilation
20-----------
21
22 If necessary, modify the toolchain settings in the Makefile.
23 Invoke make:
24 $ make
25
26Verification
27------------
28
29 To verify that the library is working, it is necessary to specify a
30 different makefile target than that used for normal compilation, thus:
31
32 $ make test
33
34API documentation
35-----------------
36
37 Currently, there is none. However, the code is well commented and the
38 public API may be found in the "include" directory. The testcase sources
39 may also be of use in working out how to use it.
40
41