summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers@digital-scurf.org>2016-11-19 09:58:19 (GMT)
committer Daniel Silverstone <dsilvers@digital-scurf.org>2016-11-19 09:58:19 (GMT)
commit00f66c004fc24e381151937d15f58ee30cabce7f (patch)
treea65e88f1f8238633ebc0ad10c72b72deb28c42e6
parent4b4996ba93e2ae968656a41ae44d95ec5e6b9be6 (diff)
downloadlibnsutils-00f66c004fc24e381151937d15f58ee30cabce7f.tar.gz
libnsutils-00f66c004fc24e381151937d15f58ee30cabce7f.tar.bz2
Add basic READMEHEADrelease/0.0.3master
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..45e0a12
--- a/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.
+