From 00f66c004fc24e381151937d15f58ee30cabce7f Mon Sep 17 00:00:00 2001 From: Daniel Silverstone Date: Sat, 19 Nov 2016 09:58:19 +0000 Subject: Add basic README --- README | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..45e0a12 --- /dev/null +++ b/README @@ -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. + -- cgit v1.2.3