summaryrefslogtreecommitdiff
path: root/README
blob: 45e0a121f125d5e6bab70bc3456381c9664438a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Libnsutils - NetSurf utility functions
======================================

Overview
--------

  Libnsutils provides a small number of useful utility routines which
  require platform-specific implementations.

Requirements
------------

  Libnsutils requires the following tools:

    + A C99 capable C compiler
    + GNU make or compatible
    + Pkg-config

Compilation
-----------

  If necessary, modify the toolchain settings in the Makefile.
  Invoke make:
  		$ make

Verification
------------

  To verify that the library is working, it is necessary to specify a 
  different makefile target than that used for normal compilation, thus:
  
  		$ make test

API documentation
-----------------

  Currently, there is none. However, the code is well commented and the 
  public API may be found in the "include" directory. The testcase sources 
  may also be of use in working out how to use it.