Read Me

Word Search Solver (wss)
Solves word searches.
Author:	arkenflame
Date: 10-3-07

Description:
I hate word searches. They are nothing but busy work. Computers happen to be good at that sort of thing, so I wrote a program to solve them. It has a long way to go, but it works (i.e., finds words running in all directions). Currently wss only runs in a terminal, and takes a text file as an argument. The proper format is laid out below.

Installation:
1. Download and install Python from python.org. wss was developed and tested using python 2.5.1, but earlier/later versions may work.
2. Decompress wss.py to any folder.
3. Enter a word search into a text file using the format below.
4. Type 'python wss.py FILENAME.TXT' into the terminal, where 'FILENAME.TXT' is the path to the wordsearch.
5. The program will print output to the screen. Type 'python wss.py --help' for more options.

The Word Search Format:
Lay out a word search text file as between the lines (case does not matter):
--------------------------------------------------------------------
-PUZZLEBLOCK-
thesearethelines
ofthewordsearchy
oushouldputyouro
wnstuffherezzzzz
-ENDPUZZLEBLOCK-
-WORDBANK-
lines
owe
us
your
stuff
-ENDWORDBANK-
---------------------------------------------------------------------
The words between the dashes are very important. You can switch the locations of the puzzle block and word bank if you wish. Email me at arkenflame@users.sourceforge.net with questions, comments, concerns or suggestions. Please do not ask me to make a gui interface. I'll do that when I get around to it.