summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/spelatex/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/spelatex/README')
-rw-r--r--macros/latex/contrib/spelatex/README61
1 files changed, 61 insertions, 0 deletions
diff --git a/macros/latex/contrib/spelatex/README b/macros/latex/contrib/spelatex/README
new file mode 100644
index 0000000000..f20fa8b948
--- /dev/null
+++ b/macros/latex/contrib/spelatex/README
@@ -0,0 +1,61 @@
+********************************************************************
+* *
+* The spelatex package *
+* *
+********************************************************************
+ Walter Daems
+ walter.daems(at)uantwerpen.be
+
+
+SpeLaTeX equips the PDF that is generated with LaTeX with hyperlinks
+to audio files that contain the spoken equivalent of the original
+text, equations, figures and tables.
+
+The audio files can be automatically generated using a Perl-script
+called spel-wizard.pl (part of the SpeL::Wizard module available on
+CPAN). This script interfaces with locally installed text-to-speech
+software or with online available (paying) cloud services to generate
+the audio files. To this end, the LaTeX chunks of your text are parsed
+and translated to 'natural language'.
+
+SpeLaTeX is babel enabled, such that your text is read with the
+correct pronunciation corresponding to your language. So far, it
+provides the languages English and Dutch, but it will be extended in
+the future.
+
+You can package your PDF together with the audio-files (in your
+favorite archive format) and make it available to your users, such
+that the only requirements to read your text and listen to the audio
+are a suited PDF reader and media player. Not all readers and players
+work. Working readers are: okular, acrobat reader, pdfxchange
+viewer. Working media players are: SoX, totem, vlc.
+
+The package is part of the SpeLbox package, consisting of
+- an Emacs Org-mode exporter, called ox-spelatex (under development,
+ will be released soon)
+- the LaTeX spelatex package itself
+- a perl script 'spel-wizard.pl' available from CPAN in the SpeL::Wizard
+ module, that converts text to speech (doing the magic, parsing your
+ equations).
+
+The package also functions without the Org-Mode exporter, the latter
+just being there to make use more convenient. For the text-to-speech
+conversion, one can use free options (festival, balabolka, ...) or
+paying services (e.g. AWS polly).
+
+Do you like this package? You're welcome to send us beer, wine, or
+just an e-mail with kind words.
+
+If you want to contribute to the package (e.g., by providing some
+extra babel support for your language), please contact me.
+
+License
+=======
+
+see file LICENSE
+
+
+History
+=======
+
+see PDF documentation