notes

1 files changed, 21 insertions, 0 deletions

diff --git a/includes/normal/README b/includes/normal/README
index 3424507d6f27..f8207a1b2e3e 100644
--- a/includes/normal/README
+++ b/includes/normal/README
@@ -32,3 +32,24 @@ have been changed or you remove it.
 data from from the net if necessary. If it reports failure, something is
 going wrong!
 
+
+== Benchmarks ==
+
+Run 'make bench' to download some sample texts from Wikipedia and run some
+cheap benchmarks of some of the functions. Take all numbers with large
+grains of salt.
+
+
+== PHP module extension ==
+
+There's an experimental PHP extension module which wraps the ICU library's
+normalization functions. This is *MUCH* faster than doing this work in pure
+PHP code. This is in the 'normal' directory in MediaWiki's CVS extensions
+module. It is known to work with PHP 4.3.8 and 5.0.2 on Linux/x86 but hasn't
+been thoroughly tested on other configurations.
+
+If the php_normal.so module is loaded in php.ini, the normalization functions
+will automatically use it. If you can't (or don't want to) load it in php.ini,
+you may be able to load it using the dl() function before include()ing or
+require()ing UtfNormal.php, and it will be picked up.
+