commit 9b498b410035296905d83f278998fee4a467795b
parent 6faeeca1d383f43cbc904904dbf7c7a6e3193461
Author: umhau <umhau@alum.gcc.edu>
Date: Sun, 4 Jun 2017 16:49:32 -0400
Reshaped readme file
Diffstat:
| M | README | | | 43 | ++++++++++++++++++++++--------------------- |
1 file changed, 22 insertions(+), 21 deletions(-)
diff --git a/README b/README
@@ -1,22 +1,23 @@
Voice model creator for CMU Sphinx
-===================================================================================================
+===============================================================================
-This tool contains basic tools for creating a custom domain voice model for use with the
-PocketSphinx decoder. It is also possible to use the voice models created by this tool as the
-basis for a test-to-speech engine.
+This tool contains basic tools for creating a custom domain voice model for use
+with the PocketSphinx decoder. It is also possible to use the voice models
+created by this tool as the basis for a test-to-speech engine.
Note this tool has only been tested with Linux Mint 17.3 & 18.
**Please see the LICENSE file for terms of use.**
Linux/Unix installation
----------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
-You should install dependencies first; this ensures that python-dev, PocketSphinx, etc. are
-available. Second, install vmc. Some of the packages need to be installed within the user's home
-directory; ~/tools is recommended. This should be specified when installing the dependencies. Full
-installation on an AMD64 computer running Mint 18 would look like this:
+You should install dependencies first; this ensures that python-dev,
+PocketSphinx, etc. are available. Second, install vmc. Some of the packages
+need to be installed within the user's home directory; ~/tools is recommended.
+This should be specified when installing the dependencies. Full installation on
+an AMD64 computer running Mint 18 would look like this:
Commands:
@@ -29,7 +30,7 @@ Commands:
See use examples in the next section.
Usage instructions
----------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
Example usage, recording new audio with 5 repetitions of each sentence:
@@ -39,20 +40,20 @@ Example usage, importing previously created audio files:
$ vmc.sh ccmodel -import audio_files cc.list ~/tools/ccmodel
-Note that the model name and the name of the model folder should be the same. Also note the
-repetitions specification is optional; it defaults to 1.
+Note that the model name and the name of the model folder should be the same.
+Also note the repetitions specification is optional; it defaults to 1.
-The model folder will contain all necessary files to run PocketSphinx with the newly created custom
-voice model.
+The model folder will contain all necessary files to run PocketSphinx with the
+newly created custom voice model.
-Note that dependencies are not checked when running vmc.sh. To check dependencies, see the section
-above.
+Note that dependencies are not checked when running vmc.sh. To check
+dependencies, see the section above.
Background
----------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
-This tools brings together a number of disparate data files that are needed for creating a voice
-model. This graph illustrates the data process involved:
+This tools brings together a number of disparate data files that are needed for
+creating a voice model. This graph illustrates the data process involved:
word domain
+
@@ -73,6 +74,6 @@ model. This graph illustrates the data process involved:
v
voice model
-Each of these steps, starting with the sentence list (given) and ending with the voice model are
-contained within this tool.
+Each of these steps, starting with the sentence list (given) and ending with
+the voice model are contained within this tool.