language: Document sources of data and example usage

Change-Id: I0c72069d010285d9b88ff83bc1478410961065d3

diff --git a/languages/data/README.md b/languages/data/README.md
new file mode 100644 (file)
index 0000000..8a13fdc
--- /dev/null
+++ b/languages/data/README.md
@@ -0,0 +1,7 @@
+## normalize-ar.phpc
+
+Generated by `maintenance/language/generateNormalizerDataAr.php`.
+
+## normalize-ml.php
+
+Generated by `maintenance/language/generateNormalizerDataMl.php`.

diff --git a/languages/data/normalize-ar.php b/languages/data/normalize-ar.php
index c1daf20..f54b231 100644 (file)
--- a/languages/data/normalize-ar.php
+++ b/languages/data/normalize-ar.php
@@ -1,5 +1,5 @@
 <?php
-// File created by maintenance/generateNormalizerDataAr.php
+// File created by generateNormalizerDataAr.php
 return [
        'ﭐ' => 'ٱ',
        'ﭑ' => 'ٱ',

diff --git a/languages/data/normalize-ml.php b/languages/data/normalize-ml.php
index ca89a5a..1cf8548 100644 (file)
--- a/languages/data/normalize-ml.php
+++ b/languages/data/normalize-ml.php
@@ -1,5 +1,5 @@
 <?php
-// File created by maintenance/generateNormalizerDataMl.php
+// File created by generateNormalizerDataMl.php
 return [
        'ണ്‍' => 'ൺ',
        'ന്‍' => 'ൻ',

diff --git a/maintenance/language/generateNormalizerDataAr.php b/maintenance/language/generateNormalizerDataAr.php
index af47d65..fad35cb 100644 (file)
--- a/maintenance/language/generateNormalizerDataAr.php
+++ b/maintenance/language/generateNormalizerDataAr.php
@@ -28,6 +28,11 @@ require_once __DIR__ . '/../Maintenance.php';
  *
  * This data file is used after normalizing to NFC.
  *
+ * Example usage:
+ *
+ *    curl 'https://unicode.org/Public/6.0.0/ucd/UnicodeData.txt' > /tmp/UnicodeData.txt
+ *    php generateNormalizerDataAr.php --unicode-data-file /tmp/UnicodeData.txt
+ *
  * @ingroup MaintenanceLanguage
  */
 class GenerateNormalizerDataAr extends Maintenance {