diff options
author | Daniel Silverstone <dsilvers@digital-scurf.org> | 2016-11-19 09:58:19 +0000 |
---|---|---|
committer | Daniel Silverstone <dsilvers@digital-scurf.org> | 2016-11-19 09:58:19 +0000 |
commit | 00f66c004fc24e381151937d15f58ee30cabce7f (patch) | |
tree | a65e88f1f8238633ebc0ad10c72b72deb28c42e6 /README | |
parent | 4b4996ba93e2ae968656a41ae44d95ec5e6b9be6 (diff) | |
download | libnsutils-fb5d44c613b51e494a501c91d5e7865c7d87931d.tar.gz libnsutils-fb5d44c613b51e494a501c91d5e7865c7d87931d.tar.bz2 |
Add basic READMErelease/0.0.3
Diffstat (limited to 'README')
-rw-r--r-- | README | 40 |
1 files changed, 40 insertions, 0 deletions
@@ -0,0 +1,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. + |