Read Me

1.  What does PyMorseRSS do?

PyMorseRSS is a set of Python scripts designed to generate Morse code
practice files nightly and propagate them via RSS.  It's only
lowercased to make SourceForge happy.

2.  What is included in this release?

generate-data-files.py -- a Python script which builds Morse code files
generate-rss-files.py -- a Python script which builds RSS files (duh)
images -- a directory containing images used in the RSS files
lib -- a directory containing Python modules used in the scripts
voice -- a directory containing voice files for generating answer keys
farnsworth-test.py -- a Python script to test Farnsworth generation
paris-test.py -- a Python script to test timing via the PARIS method

3.  What other software is required?

Python 2.5 or greater is required for this package because it depends
upon xml.etree.ElementTree which was not included until version 2.5.

In addition, MP3 support requires LAME be installed.  See
http://lame.sourceforge.net/ for details.  OGG support requires Vorbis
Tools be installed.  See http://www.vorbis.com/ for details.

4.  How do I use PyMorseRSS?

Extract the bundle to a destination directory.  Modify
generate-data-files.py and generate-rss-files.py to match your
environment, then run them by hand to determine how much time will be
required for them to run in sequence.

Then add these scripts to cron like so:

50 19 * * * (cd /home/jmt/PyMorseRSS && env TERM=vt100 /usr/local/bin/python ./generate-data-files.py && /usr/local/bin/python ./generate-rss-files.py)

The 'env TERM=vt100' bit is included to deal with a bug in LAME that
may be fixed in some releases so it may not be required for all
installations.  Adjust the time in the cron job to cause the RSS file
generation to complete just before midnight for best effect.

5.  Where do I get help?

This code is actively maintained by jtwilley@sourceforge.net.  If you 
have any questions, comments, suggestions or criticism please don't 
hesitate to send email, and don't forget to put 'PyMorseRSS' in the 
subject!