From f515d02163d301d33c3afcff0ae6aaf4b2c61fc0 Mon Sep 17 00:00:00 2001
From: Ingmar Steiner <steiner@coli.uni-saarland.de>
Date: Tue, 29 Aug 2017 14:00:52 +0200
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..78d7c09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# voice-cmu-awb-time
+
+A male Scottish English limited-domain unit selection voice for [MaryTTS](http://mary.dfki.de/) built from [recordings provided by CMU](http://festvox.org/cmu_arctic/)
+
+## Prerequisites
+
+You will need to have [Java](https://www.java.com/), [Praat](http://praat.org/), [SoX](http://sox.sourceforge.net/), and the [Edinburgh Speech Tools](http://www.cstr.ed.ac.uk/projects/speech_tools/) installed.
+On OSX with [Homebrew](http://brew.sh/), do
+```
+$ brew cask install java praat
+$ brew install sox speech-tools
+```
+as needed.
+
+On Debian-based Linux (including Ubuntu), do
+```
+$ sudo apt-get install default-jdk praat sox speech-tools
+```
+accordingly.
+
+### Initializing the build
+
+Do
+```
+$ ./gradlew legacyInit
+```
+
+### Building the voice
+
+To assemble, test, and package the voice for another MaryTTS installation, do
+```
+$ ./gradlew build
+```
+The packaged files will be placed under `build/distributions`.
+Copy the zip file and xml descriptor into your MaryTTS installation's `download` directory, then run the `marytts-component-installer` to install the voice.
+
+### Running the voice
+
+To build the voice and run it in an ad-hoc MaryTTS server, do
+```
+$ ./gradlew run
+```
+Then, go to [http://localhost:59125](http://localhost:59125/).