From de98026b95c477e4b4dfda1cffdd43b8042608ac Mon Sep 17 00:00:00 2001
From: Kovachev <86124720+KovachevBot@users.noreply.github.com>
Date: Mon, 5 Jun 2023 19:27:47 +0100
Subject: [PATCH] Create README.md

---
 bulgarian-derived-forms/README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 bulgarian-derived-forms/README.md

diff --git a/bulgarian-derived-forms/README.md b/bulgarian-derived-forms/README.md
new file mode 100644
index 0000000..1a7de9d
--- /dev/null
+++ b/bulgarian-derived-forms/README.md
@@ -0,0 +1,11 @@
+# Bulgarian Derived form generator
+The purpose of this script is to automatically generate Bulgarian derived form entries from nouns' declension tables.
+It was developed in 2021 to improve the coverage of non-lemma forms of Bulgarian nouns, however was not approved by consensus and hence did not make it to deployment.
+One reason for this was that most noun forms are straightforward sum-of-parts suffixations of the base noun, hence the expansion did not provide
+much benefit whilst remaining a complex and error-prone task.
+
+## Function
+The exact method of operation is described by the code itself, but the gist is the following:
+- The noun lemma is found and the relevant declension table section is expanded to its HTML/Wikicode form.
+- The declension data is interpreted depending on the specific labels and values in the table.
+- Entries that correspond to each declension are generated and appended to their respectively-titled pages.