jrIndex 1.0.0 README.TXT

CONTENTS
=======================================================================================
1. What is jrIndex?
2. How do I use it?
3. How does it actually work?
4. Where is the source code?
5. How may I report bugs?
6. Are any future releases planned?
7. Who wrote jrIndex?
=======================================================================================


1. What is jrIndex?

jrIndex is a freeware program that quickly produces an HTML index of all of the MP3 (or
any other format that the user specifies) files in any directory.


2. How do I use it?

Unpack this ZIP file into any directory.  Now, open a DOS prompt and change to the
directory where you unpacked the files.  Issue a "dir /s" on the directory you wish
to index, redirecting the output to a file.  All filenames that appear in this file
will also appear in the index, so use wildcards to include only the files that you
want.  For example, if you want to index all of the MP3 files in a directory called
C:\MY_MP3S, you would type, from the directory where jrIndex resides: 
"dir c:\my_mp3s\*.mp3 /s > 1.txt"  Then, you simply run jrIndex, give it the file
name of the text file that you have just created and a file name for the resulting
HTML index.  jrIndex will do the rest.


3. How does it actually work?

jrIndex was written in C++, so if you know C++, take a look at the JRINDEX.CPP file
that is inclosed in this distribution ZIP.  Here is a quick overview of how jrIndex
works.  First of all, the index that is generated is nothing more than long file
names with some HTML code wrapped around them for formatting.  So jrIndex looks at
the text dump of the dir command (the file that you specify) and reads in strings 
until it comes to a date.  Then, it reads in the rest of the line and outputs it to
the HTML file.  It continues this process until it comes across the string "listed:"
which I found to be a good EOF flag for my purposes.  If you don't understand why
this process works, take a look at the text dump of a dir /s sometime!


4. Where is the source code?

In this ZIP!


5. How may I report bugs?

Email me, jmglov@mail.wm.edu and I will address them as best I can!


6. Are there any future releases planned?

Yes, I actually intend to turn this little C++ program into a full-blown class AND
and OLE custom control (so it may be plugged into Windows apps to add the indexing
functionality).  As I have time, I will write and release these.


7. Who wrote jrIndex?

Josh Glover, an English / Computer Science major (with a Japanese Studies minor!)
at the College of William and Mary, in historic Williamsburg, VA, USA.

I am also involved in writing a program that translates romanji (Japanese words
represented with the English alphabet) into hiragana and katakana and vice-versa.

Email me at jmglov@mail.wm.edu with questions, comments, or complaints!