Browse Source

Convert the index.html documentation to markdown.

master
Reece H. Dunn 9 years ago
parent
commit
32ad5a1283
4 changed files with 74 additions and 88 deletions
  1. 2
    1
      Makefile.am
  2. 6
    0
      README.md
  3. 0
    87
      docs/index.html
  4. 66
    0
      docs/index.md

+ 2
- 1
Makefile.am View File

%.html: %.md _layouts/webpage.html %.html: %.md _layouts/webpage.html
cat $< | sed -e 's/\.md)/.html)/g' | kramdown --template _layouts/webpage.html > $@ cat $< | sed -e 's/\.md)/.html)/g' | kramdown --template _layouts/webpage.html > $@


docs: README.html
docs: docs/index.html \
README.html


docs/speak_lib.h: src/include/espeak-ng/speak_lib.h docs/speak_lib.h: src/include/espeak-ng/speak_lib.h
cp $< $@ cp $< $@

+ 6
- 0
README.md View File

- [Cross-Compiling For Windows](#cross-compiling-for-windows) - [Cross-Compiling For Windows](#cross-compiling-for-windows)
- [Testing](#testing) - [Testing](#testing)
- [Installing](#installing) - [Installing](#installing)
- [Documentation](#documentation)
- [Building Voices](#building-voices) - [Building Voices](#building-voices)
- [Adding New Voices](#adding-new-voices) - [Adding New Voices](#adding-new-voices)
- [Praat Changes](#praat-changes) - [Praat Changes](#praat-changes)


find /usr/lib | grep libespeak-ng find /usr/lib | grep libespeak-ng


## Documentation

The [main documentation](docs/index.md) for eSpeak NG provides more information
on using and creating voices/languages for for eSpeak NG.

## Building Voices ## Building Voices


If you are modifying a language's phoneme, voice or dictionary files, you If you are modifying a language's phoneme, voice or dictionary files, you

+ 0
- 87
docs/index.html View File

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>eSpeak: Speech Synthesizer</title>
</head>
<body>

<table border="1" cellpadding="10" background="images/sand-light.jpg">
<tbody>
<tr>
<td width="15%" valign="top">
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=159649&amp;type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a>
</td>
<td>
<div align="center"><IMG src="images/lips.png" width="193" height="172" border="0">
<h1>eSpeak text to speech</h1></div>
<div align="center">
(email) &nbsp; jonsd at users dot sourceforge.net<br>
<a href="http://espeak.sf.net/download.html"><strong>Download</strong></a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://sourceforge.net/projects/espeak/"><strong>eSpeak Sourceforge page</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://sourceforge.net/forum/?group_id=159649"><strong>Forum</strong></a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://sourceforge.net/mail/?group_id=159649"><strong>Mailing list</strong></a>
</div>
</td>
</tr>
<tr>
<td valign="top">
<font size="+1"><strong>
<A href="commands.html">Usage</a>
<p>
<A href="languages.html">Languages</A>
<p>
<A href="docindex.html">Documents</A>
<p>
<A href="http://espeak.sf.net/samples.html">Samples</A>
<p>
<A href="http://espeak.sf.net/license.html">License</A>
</strong></font>
</td>
<td>
eSpeak is a compact open source software speech synthesizer for English and other languages, for Linux and Windows. &nbsp;
<a href="http://espeak.sourceforge.net/"><strong>http://espeak.sourceforge.net</strong></a>
<p>
eSpeak uses a "formant synthesis" method. This allows many languages to be provided in a small size. The speech is clear, and can be used at high speeds, but is not as natural or smooth as larger synthesizers which are based on human speech recordings.
<p>
eSpeak is available as:
<ul>
<li>A command line program (Linux and Windows) to speak text from a file or from stdin.
<li>A shared library version for use by other programs. (On Windows this is a DLL).
<li>A SAPI5 version for Windows, so it can be used with screen-readers and other programs that support the Windows SAPI5 interface.
<li>eSpeak has been ported to other platforms, including Solaris and Mac OSX.
</ul>
Features.
<ul>
<li>Includes different Voices, whose characteristics can be altered.
<li>Can produce speech output as a WAV file.
<li>SSML (Speech Synthesis Markup Language) is supported (not complete), and also HTML.
<li>Compact size. The program and its data, including many languages, totals about 1.4 Mbytes.
<li>Can be used as a front-end to MBROLA diphone voices, see <a href="mbrola.html">mbrola.html</a>. eSpeak converts text to phonemes with pitch and length information.
<li>Can translate text into phoneme codes, so it could be adapted as a front end for another speech synthesis engine.
<li>Potential for other languages. Several are included in varying stages of progress. Help from native speakers for these or other languages is welcome.
<li>Development tools are available for producing and tuning phoneme data.
<li>Written in C.
</ul>
<p>
I regularly use eSpeak to listen to blogs and news sites. I prefer the sound through a domestic stereo system rather than small computer speakers, which can sound rather harsh.

<hr>
<strong>Languages</strong>. The eSpeak speech synthesizer supports several languages, however in many cases these are initial drafts and need more work to improve them. Assistance from native speakers is welcome for these, or other new languages. Please contact me if you want to help.<p>
eSpeak does text to speech synthesis for the following languages, some better than others. Afrikaans, Albanian, Armenian, Cantonese, Catalan, Croatian, Czech, Danish, Dutch, English, Esperanto, Finnish, French, German, Greek, Hindi, Hungarian, Icelandic, Indonesian, Italian, Kurdish, Latvian, Lojban, Macedonian, Mandarin, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Spanish, Swahili, Swedish, Tamil, Turkish, Vietnamese, Welsh.
<hr>
The latest <strong>development version</strong> is at:
<a href="http://espeak.sf.net/test/latest.html">espeak.sf.net/test/latest.html</a>.
<hr>
<strong>espeakedit</strong> is a GUI program used to prepare and compile phoneme data. It is now available for download. Documentation is currently sparse, but if you want to use it to add or improve language support, let me know.
<hr>
History. Originally known as <strong>speak</strong> and originally written for Acorn/RISC_OS computers starting in 1995. This version is an enhancement and re-write, including a relaxation of the original memory and processing power constraints, and with support for additional languages.
</td>
</tr>
</tbody>
</table>

</body>
</html>

+ 66
- 0
docs/index.md View File

# eSpeak NG: Speech Synthesizer

- [Features](#features)
- [History](#history)
- [Installation](commands.html)
- [Languages](languages.html)
- [Documents](docindex.html)
- [License](../COPYING)

----------

eSpeak NG is a compact open source software speech synthesizer for English and
other languages, for Linux and Windows.

eSpeak NG uses a "formant synthesis" method. This allows many languages to be
provided in a small size. The speech is clear, and can be used at high speeds,
but is not as natural or smooth as larger synthesizers which are based on human
speech recordings.

eSpeak is available as:

* A command line program (Linux and Windows) to speak text from a file or
from stdin.
* A shared library version for use by other programs. (On Windows this is
a DLL).
* A SAPI5 version for Windows, so it can be used with screen-readers and
other programs that support the Windows SAPI5 interface.
* eSpeak has been ported to other platforms, including Solaris and Mac OSX.

## Features

* Includes different Voices, whose characteristics can be altered.
* Can produce speech output as a WAV file.
* SSML (Speech Synthesis Markup Language) is supported (not complete),
and also HTML.
* Compact size. The program and its data, including many languages,
totals about 1.4 Mbytes.
* Can be used as a front-end to [MBROLA diphone voices](mbrola.html).
eSpeak NG converts text to phonemes with pitch and length information.
* Can translate text into phoneme codes, so it could be adapted as a
front end for another speech synthesis engine.
* Potential for other languages. Several are included in varying stages
of progress. Help from native speakers for these or other languages is
welcome.
* Written in C.

The eSpeak speech synthesizer supports over 70 languages, however in many cases
these are initial drafts and need more work to improve them. Assistance from
native speakers is welcome for these, or other new languages. Please contact me
if you want to help.

## History

The program was originally known as __speak__ and originally written
for Acorn/RISC\_OS computers starting in 1995 by Jonathan Duddington. This was
enhanced and re-written in 2007 as __eSpeak__, including a relaxation of the
original memory and processing power constraints, and with support for additional
languages.

In 2010, Reece H. Dunn started maintaining a version of eSpeak on GitHub that
was designed to make it easier to build eSpeak on POSIX systems, porting the
build system to autotools in 2012. In late 2015, this project was officially
forked to a new eSpeak NG project. The new eSpeak NG project is a significant
departure from the eSpeak project, with the intention of cleaning up the
existing codebase, adding new features and adding and improving to the
supported languages.

Loading…
Cancel
Save