summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers@digital-scurf.org>2017-06-11 12:57:49 (GMT)
committer Daniel Silverstone <dsilvers@digital-scurf.org>2017-06-11 12:57:49 (GMT)
commitba105634e4e7e32f1262c3c4e6d7d208ca054d17 (patch)
treebdd37663bd5898b1961b41afeaa8f4d246170a78
parent0d8bf0efca755ba4446a213d500975de65098dd0 (diff)
downloadlibnslog-ba105634e4e7e32f1262c3c4e6d7d208ca054d17.tar.gz
libnslog-ba105634e4e7e32f1262c3c4e6d7d208ca054d17.tar.bz2
tweak README
-rw-r--r--README23
1 files changed, 13 insertions, 10 deletions
diff --git a/README b/README
index 45e0a12..0a2cbd3 100644
--- a/README
+++ b/README
@@ -1,20 +1,24 @@
-Libnsutils - NetSurf utility functions
-======================================
+Libnslog - NetSurf Logging Library
+==================================
Overview
--------
- Libnsutils provides a small number of useful utility routines which
- require platform-specific implementations.
+ Libnslog provides a category-based logging library which supports complex
+ logging filters, multiple log levels, and provides context through to client
+ applications.
Requirements
------------
- Libnsutils requires the following tools:
+ Libnslog requires the following tools:
+ A C99 capable C compiler
+ GNU make or compatible
+ Pkg-config
+ + Check (test framework only)
+ + Flex
+ + Bison
Compilation
-----------
@@ -26,15 +30,14 @@ Compilation
Verification
------------
- To verify that the library is working, it is necessary to specify a
+ 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
+ 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.
-