From 1d847c127ae8974a96984dea2e6f47f3dd3dc921 Mon Sep 17 00:00:00 2001
From: Sting <loic.allegre@ensiie.fr>
Date: Mon, 24 Jul 2023 19:43:32 +0200
Subject: [PATCH] Update README + requirements

---
 README.md        | 25 +++++++++++++++++++++++++
 requirements.txt |  1 +
 2 files changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 9471adb..5239f2f 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,16 @@ $ deactivate
 Having a CUDA-capable GPU is optional, but can greatly reduce processing time in some situations.
 
 
+To use the custom phonetic mapping for Japanese Romaji, you need to update manually (for now) the g2p DB (within the venv):
+```bash
+$ cp g2p/mappings/langs/rji/* env/lib/python3.11/site-packages/g2p/mappings/langs/rji/
+
+#Then update :
+$ g2p update
+```
+
+
+
 # Use
 
 ## Autokara
@@ -92,6 +102,21 @@ To execute AutoKara on a (pre-extracted) WAV (or OGG, MP3, ...) vocals file, pas
 $ python autokara.py vocals.wav output.ass --vocals
 ```
 
+To use a phonetic transcription optimized for a specific language, use `--lang` (or `-l`) :
+```bash
+$ python autokara.py vocals.wav output.ass --lang jp
+```
+Available languages are :
+```
+jp : Japanese Romaji (default)
+en : English
+```
+
+Full help for all options is available with :
+```bash
+$ python autokara.py -h
+```
+
 ## Useful scripts
 
 To only extract .wav audio from a MKV file :
diff --git a/requirements.txt b/requirements.txt
index 8b063f5..0429914 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -21,4 +21,5 @@ torchaudio
 tensorboard
 sortedcontainers
 g2p_en
+g2p
 resampy
\ No newline at end of file
-- 
GitLab