diff --git a/README b/README.md similarity index 88% rename from README rename to README.md index 610f224..ebe56bc 100644 --- a/README +++ b/README.md @@ -1,12 +1,10 @@ -espeakup connector -======================= +# espeakup connector espeakup is a program which makes it possible for speakup to use the espeak software synthesizer. It does this by reading speakup's softsynth device and passing the text to espeak which actually speaks. -Requirements -============ +## Requirements This program works with the speakup screen reader, which can be obtained from http://linux-speakup.org, and the espeak software speech @@ -14,8 +12,7 @@ synthesizer which can be obtained from http://espeak.sourceforge.net. You must have both of these installed and operational. Setting them up is beyond the scope of this document. -Installation -============ +## Installation The preferred way to install espeakup is using your distribution's packaging system, but if your distribution does not have a package for @@ -23,16 +20,14 @@ espeakup yet, espeakup just uses a Makefile, so you should be able to change to the source directory, then type make, then as root, make install. -Starting Up -=========== +## Starting Up This program should be run after speakup is set up to communicate with a software synthesizer and after /dev/softsynth exists. The way this is done is distribution specific, so it is beyond the scope of this documentation. -Command Line Options -==================== +## Command Line Options Espeakup currently accepts the following command line options: @@ -41,16 +36,14 @@ Espeakup currently accepts the following command line options: --help, -h Show this help. --version, -v Display the software version. -Acknowledgements -================ +## Acknowledgements I would like to thank Marc Mulcahy, the author of the speakup to TTSynth connector, on which this work is based. Also, I would like to thank Kirk Reiser and Jonathan Duddington, the authors of Speakup and Espeak, respectively, for their work. -Filing Bugs -==== +## Filing Bugs Bugs should be filed on our bug tracker at https://github.com/linux-speakup/issues.