Merge pull request #5 from klb2/installation-instruction

Add installation instructions Former-commit-id: 14fe4eb
R2D2FISH · Nov 9, 2022 · 3490ea7 · 3490ea7
2 parents d984e94 + 325a1db
commit 3490ea7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,3 +24,16 @@ The initial, regular Tacotron model was trained first on LJSpeech, and then on a
 * The Forward Tacotron model was only trained on about 600 voice lines.
 * The HiFiGAN model was generated through transfer learning from the sample.
 * All models have been optimized and quantized.
+
+
+
+## Installation Instruction
+If you want to install the TTS Engine on your machine, please follow the steps
+below.
+
+1. Install the [`espeak`](https://github.com/espeak-ng/espeak-ng) synthesizer
+   according to the [installation
+   instructions](https://github.com/espeak-ng/espeak-ng/blob/master/docs/guide.md)
+   for your operating system.
+2. Install the required Python packages, e.g., by running `pip install -r
+   requirements.txt`
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,5 @@
+torch
+phonemizer
+inflect
+unidecode
+scipy