From 3d83e3e05c65002f9979cf6bd57812576c1681d5 Mon Sep 17 00:00:00 2001
From: John Mark Bell <jmb@netsurf-browser.org>
Date: Thu, 8 Jan 2009 20:48:14 +0000
Subject: Document how to enable iconv() support

svn path=/trunk/libparserutils/; revision=6003
---
 README | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 72041c0..a1979ad 100644
--- a/README
+++ b/README
@@ -18,7 +18,7 @@ Requirements
     + Pkg-config (for the testcases)
 
   For enhanced charset support, LibParserUtils may also be configured to use
-  an iconv() implementation.
+  an iconv() implementation, see the "Enabling iconv() support" section, below.
 
 Compilation
 -----------
@@ -42,3 +42,22 @@ API documentation
   public API may be found in the "include" directory. The testcase sources 
   may also be of use in working out how to use it.
 
+Enabling iconv() support
+------------------------
+
+  By default, libparserutils only supports the following character sets:
+
+    + UTF-16 (platform-native endian)
+    + UTF-8
+    + ISO-8859-n
+    + Windows-125n
+    + US-ASCII
+
+  Support for more character sets may be enabled through the use of iconv().
+  To enable iconv() support in libparserutils, do the following:
+
+  		$ echo "CFLAGS += -DWITH_ICONV_FILTER" \
+				>build/Makefile.config.override
+
+  Then build libparserutils as normal.
+
-- 
cgit v1.2.3