From 0107f7bad3cc5bc87af78756247c35edcfb7a76b Mon Sep 17 00:00:00 2001
From: Kwoth <master.kwoth@gmail.com>
Date: Tue, 3 Aug 2021 23:51:25 +0200
Subject: [PATCH] Removed cmd-versions.json (?) and added some explanatory
 README.md's for individual projects

---
 cmd-versions.json                   | 13 -------------
 src/NadekoBot.Coordinator/README.md |  0
 src/NadekoBot.Generators/README.md  | 24 ++++++++++++++++++++++++
 src/NadekoBot.Tests/README.md       |  1 +
 4 files changed, 25 insertions(+), 13 deletions(-)
 delete mode 100644 cmd-versions.json
 create mode 100644 src/NadekoBot.Coordinator/README.md
 create mode 100644 src/NadekoBot.Generators/README.md
 create mode 100644 src/NadekoBot.Tests/README.md

diff --git a/cmd-versions.json b/cmd-versions.json
deleted file mode 100644
index 20870f274..000000000
--- a/cmd-versions.json
+++ /dev/null
@@ -1,13 +0,0 @@
-[
-  "2.45.2",
-  "2.45.1",
-  "2.45.0",
-  "2.44.4",
-  "2.44.2",
-  "2.44.0",
-  "2.43.0",
-  "2.42.0",
-  "2.41.0",
-  "2.40.0",
-  "2.39.1"
-]
\ No newline at end of file
diff --git a/src/NadekoBot.Coordinator/README.md b/src/NadekoBot.Coordinator/README.md
new file mode 100644
index 000000000..e69de29bb
diff --git a/src/NadekoBot.Generators/README.md b/src/NadekoBot.Generators/README.md
new file mode 100644
index 000000000..a9c2e2f92
--- /dev/null
+++ b/src/NadekoBot.Generators/README.md
@@ -0,0 +1,24 @@
+## Generators
+
+Project which contains source generators required for NadekoBot project
+
+---
+### 1) Localized Strings Generator
+
+    -- Why --
+    Type safe response strings access, and enforces correct usage of response strings.
+
+    -- How it works --
+    Creates a file "strs.cs" containing a class called "strs" in "NadekoBot" namespace.
+    
+    Loads "data/strings/responses.en-US.json" and creates a property or a function for each key in the responses json file based on whether the value has string format placeholders or not.
+
+    - If a value has no placeholders, it creates a property in the strs class which returns an instance of a LocStr struct containing only the key and no replacement parameters
+    
+    - If a value has placeholders, it creates a function with the same number of arguments as the number of placeholders, and passes those arguments to the LocStr instance
+
+    -- How to use --
+    1. Add a new key to responses.en-US.json "greet_me": "Hello, {0}"
+    2. You now have access to a function strs.greet_me(obj p1)
+    3. Using "GetText(strs.greet_me("Me"))" will return "Hello, Me"
+
diff --git a/src/NadekoBot.Tests/README.md b/src/NadekoBot.Tests/README.md
new file mode 100644
index 000000000..738a87933
--- /dev/null
+++ b/src/NadekoBot.Tests/README.md
@@ -0,0 +1 @@
+Project which contains tests. Self explanatory
\ No newline at end of file