From 386810da3ced6eb504047ed25544c03a33f96a23 Mon Sep 17 00:00:00 2001
From: Damien Savatier <skielred@gmail.com>
Date: Tue, 13 Jun 2023 22:35:05 +0200
Subject: [PATCH] Create README.md

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3a07ec3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# tacosdbfilter
+Database merger for a certain game about tacos
+
+## Usage
+
+```
+./merge.py --help
+
+usage: merge.py [-h] [--overrides OVERRIDES] [-p {all,songs,modes,folders,default} [{all,songs,modes,folders,default} ...]] [source] [mix_with] [target]
+
+positional arguments:
+  source
+  mix_with
+  target
+
+options:
+  -h, --help            show this help message and exit
+  --overrides OVERRIDES
+  -p {all,songs,modes,folders,default} [{all,songs,modes,folders,default} ...], --patch {all,songs,modes,folders,default} [{all,songs,modes,folders,default} ...]
+```
+
+- Generate wordlist.merged.json using wordlist.json as a base and including values from wordlist.en.json if they share the same "key".
+  ```
+  ./merge.py wordlist.json wordlist.en.json wordlist.merged.json -p all
+  ```
+  Note: Those are the default values, so this is the equivalent of typing `./merge.py -p all`.
+  
+- Only include the keys that starts with "song_"
+  ```
+  ./merge.py -p songs
+  ```
+  Available "patch sets":
+  ```
+  "songs": ["song_"]
+  "folders": ["genre_", "folder_"]
+  "modes": ["mode_select_"]
+  "default": "songs" + "folders"
+  ```
+  You can combine them, like so `./merge.py -p songs -p modes`
+  
+## Helper scripts
+
+- wordlist.bin and wordlist.en.bin -> wordlist.json and wordlist.en.json
+  ```
+  ./unzip.sh
+  ```
+  
+- wordlist.merged.json -> wordlist.bin
+  ```
+  ./zip.sh
+  ```