Welcome to the speakup project for the Speakup speech package for Linux.

Speakup is written by Kirk Reiser and Andy Berdan.  It is licensed
under the GPL.  If you don't already know, the GPL stands for the GNU
General Public License.  Which basically states that this code is free to
copy, modify and distribute to anyone interested in playing with it.
The one thing you may not do is turn any part of it into proprietary
or commercial code without the permission of the author.  That's me.

If you are interested in being involved with the development of speech
output for Linux you can subscribe to the Speakup mailing list by
sending a message to speakup-request@braille.uwo.ca with the line: subscribe.  You can also subscribe by going to the speakup web page and following the links at http://www.linux-speakup.org.

We are at a very early stage in the development of this package.
Hopefully changes will happen often and many.  The current files in
this directory are:

BUGS				# the currently known bugs
COPYING 			# The GPL
Changes				# The fixes and goodies since last release
DefaultKeyAssignments		# speakup's default review keys
INSTALLATION			#  for installing speakup
README				# this file
speakupmap.map			# keyboard map for speakup functions.
keymap-tutorial			# a tutorial on how to layout the keyboard
load_spk-0.8			# directory with the loadspk and dumpspk utilities.
speakup-0.09-v2.2-patch	# patches to kernel versions 2.2.7 and above.
speakup-0.09-v2.4-patch	# patches to kernel versions 2.3.99 and above.
speakup-0.09-announcement the announcement for the current release

Read the INSTALLATION file to learn how to apply the patches and the
default.map for the keyboard.  You should also read the Changes file.
It really has any new things I've added since last time.

There is no documentation in any of these files to instruct you what
to do if something goes wrong with the patching or compilation.  If
you would like that information you will need to subscribe to the
mailing list and ask for help, or write me kirk@braille.uwo.ca for
help.  I suggest the mailing list because I will probably tire quickly
of answering the same questions over and over.  You could always
decide to wait until this package gets out of the alpha stage and
there will be more documentation by that time.

There also is a speakup reflector for the Speak Freely package, which
many of us hang out on and discuss all sorts of topics from speakup
problems to ALSA driver installation and just about anything else
you'd like to talk about.  The reflector is at lwl.braille.uwo.ca:4074
with it's lwl page at lwl.braille.uwo.ca/speakup.html.  Come and join
us, it's fun!

Acknowledgements:

I am really very new at kernel hacking and screen review package
writing, so I have depended heavily on other folks kindness to help me
a long.  No doubt I will continue to abuse them freely and others
before this is a really good speech solution for Linux.  (Oh Well!,
somebody's got to do it.)

Theodore Ts'o.  He gave me a good discussion of unicode and UTF and
the like.  He doesn't even remember writing me about it.

Alan Cox.  He has answered many questions about scheduling and wait
queues and timers along with code fragments and so on.  I just wish I
understood it all totally.

Martin Mares.  He pointed me in the right direction to figuring out
the colour attributes and other useful tidbits.

Paul McDermott.  He really is the catalyst for me to actually get
this all working.  Besides I like seeing him bounce around and get all
excited every time I have something new working.

John Covici, He was the first person to actually attempt writing
another synthesizer driver for speakup.  It was the Speakout driver so
it was also the first serial driver.

Brian Borowski, he was the first person to actually write a speakup
function other than Andy and I.

Gene Collins, he was very helpful debugging the current release prior
to its public showing.  He has also worked hard educating others on
the list and writing the ALSA mini howto.

There are probably many more I am forgetting right now.  I guess I'll
just have to add you all later.


Happy Hacking!

  Kirk

