From 580802c8626cf29a1bd738f439714b8bb1651407 Mon Sep 17 00:00:00 2001
From: Jean-Baptiste Holcroft <jean-baptiste@holcroft.fr>
Date: Nov 19 2019 06:25:24 +0000
Subject: provide explaination about results files


---

diff --git a/README.md b/README.md
index ae49fdb..700e263 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,27 @@ Applies data cleanups and enhancements (cldr name).
 Agregate the data per language, then apply it on territories (it uses stats from 
 CLDR with language per territory).
 
+# Output files
+
+* `0.error.language not in cldr.csv` contains unknown languages (lines are removed)
+* `0.error.languages is numeric.csv` contains numeric languages (lines are removed)
+* `0.error.lang with point.csv` contains languages such as ".cp936" ".big5" (lines are removed)
+* `0.error.len(language).csv` contains languages with more than three caracters (lines are removed)
+* `0.error.len(territory).csv` contains territory with more than two caracters (lines are removed)
+* `0.error.no population for this language-territory couple.csv` contains the list of language-territory couple where no language statistics exists (no impact on results)
+* `1.debug.lang.csv` all lang (language + script + territory) values for debug (no impact on results)
+* `1.debug.language.csv` all lang values for debug (no impact on results)
+* `1.debug.script.csv` all script values for debug (no impact on results)
+* `1.debug.territory.csv` all territory values for debug (no impact on results)
+* `1.debug.total message = 0.csv` all lang values for debug  (lines are removed)
+* `3.result.csv` full results per package with source filename and standardized language code, script code and territory code
+* `4.0.cldr.csv` language per territory as provided by CLDR
+* `4.1.results_per_language.csv` message and words progress percentages per language
+* `4.1.results_per_language_ISO3.csv` message and words progress percentages per language merged with "country code" database using ISO3166-1-Alpha-2 code
+* `4.2.cldr_and_results_full.csv` language per territory as provided by CLDR merged with message and words progress percentages per language
+* `4.3.cldr_and_results_grouped.csv` aggregation per territory of `4.2.cldr_and_results_full.csv`, provides the territory, the number of languages, the population, the messages and words coverage.
+* `4.4.world_stats.csv` merge results of `4.3.cldr_and_results_grouped.csv` with country database and geojson data.
+
 # Informations
 
 Data in CLDR-raw folder comes from https://github.com/unicode-org/cldr/blob/master/common/main/en.xml