feat(unitproc):Add bkipas (IPA pronunciation tool)

[BK-2020-03.git] / unitproc / bkipas.d / README.org

diff --git a/unitproc/bkipas.d/README.org b/unitproc/bkipas.d/README.org
new file mode 100644 (file)
index 0000000..2562184
--- /dev/null
+++ b/unitproc/bkipas.d/README.org
@@ -0,0 +1,17 @@
+* bkipas.d
+** Description
+This directory contains files necessary to execute the bash script
+~bkipas~.
+
+The file ~lexconvert.py~ is a python3 script referenced by [[https://github.com/espeak-ng/espeak-ng/issues/539#issuecomment-536192362][this]] post
+in the eSpeak github discussion forum. The file may be obtained at
+[[https://github.com/ssb22/lexconvert][this]] git repository. Only the required file is kept in this
+directory. ~lexconvert.py~ converts an argument IPA string into
+"eSpeak's phoneme mneumonics" that may be passed via stdout to an
+~espeak~ command.
+
+The bash script ~bkipas~ performs the ~lexconvert.py~, ~espeak~,
+and ~oggenc~ commands in order to produce an Ogg Vorbis file. An
+example of such a command group is:
+
+: $ python3 lexconvert.py --phones2phones unicode-ipa espeak "təˈmeɪtoʊ" | espeak --stdout | oggenc -o /tmp/tomato.ogg -