From 78d9f91ac9ba645b60fcc2a5fa72e2fe5965d597 Mon Sep 17 00:00:00 2001
From: John Mark Bell <jmb@netsurf-browser.org>
Date: Thu, 8 Jan 2009 20:30:48 +0000
Subject: Document "make docs" Document the Aliases file, what it's used for,
 and where a copy can be found.

svn path=/trunk/hubbub/; revision=6001
---
 README | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'README')

diff --git a/README b/README
index dd16416..822476e 100644
--- a/README
+++ b/README
@@ -72,3 +72,17 @@ API documentation
   public API may be found in the "include" directory. The "examples" 
   directory contains commented examples of how to use hubbub.
 
+  Additionally, you can use doxygen to auto-generate API documentation, thus:
+
+  		$ make docs
+
+  Then open the build/docs/html/index.html file in a web browser.
+
+A note on character set aliases
+-------------------------------
+
+  Hubbub uses an external mapping file to encode relationships between 
+  character set names. This is the "Aliases" file. A copy may be found at
+  test/data/Aliases. The path to this file is required when calling 
+  hubbub_initialise().
+
-- 
cgit v1.2.3