~jan0sch/rig

Showing details for patch 01bac893ae89c2de8a77d8e8b01cfe7700cdf7f9.
2025-04-12 (Sat), 5:50 PM - Jens Grassel - 01bac893ae89c2de8a77d8e8b01cfe7700cdf7f9

README: add information about the data file format

Summary of changes
1 files modified with 23 lines added and 0 lines removed
  • README.md with 23 added and 0 removed lines
diff -rN -u old-rig/README.md new-rig/README.md
--- old-rig/README.md	2025-04-19 12:08:20.228119276 +0000
+++ new-rig/README.md	2025-04-19 12:08:20.228119276 +0000
@@ -19,3 +19,26 @@
 After having copied the resource file you can run the code from this directory
 via `zig build run`.
 
+## Development
+
+### Data files
+
+The data files used for generating the output are simple TSV (tab separated
+values) files. All files MUST be named `lang_code.tsv` in lower case letters!
+
+### Forenames
+
+A forename file SHALL be sorted alphabetically and contain one forename per
+line.
+
+### Surnames
+
+A surname file SHALL be sorted alphabetically and contain one forename per
+line.
+
+### Zip codes and cities
+
+A zip code file SHALL be sorted by zip code and contain the zip code, the
+matching city and possible further data separated by tabs. An example for
+"further data" is the department information for french cities.
+