----------------------------------------------------------------------------
Sorune by Darren Smith
----------------------------------------------------------------------------

---------
Features:
---------
1)  A simple GUI that makes management easy (requires Perl Tk).
2)  All music formats are supported (mp3, ogg, wav, wma(non-drm)). All
    native file tags are supported.
3)  Full m3u playlist support. All associated files are added and a 
    playlist entry is created on the Neuros.
4)  Rebuild support.
5)  Files without id3 or equivalent tags can be tagged by directory 
    layout if they are organized on disk by Genre/Artist/Album/etc. 
    Note: This tagging is done solely to the Neuros. The file itself is 
    not modified (see configuration file).
6)  Sort by title on artists, genres, songs and recordings. Sort by track
    number on albums. No sorting on playlists (list order).
7)  Maintains directory/file names as well as file access/modification 
    times during sync. 
8)  Moving of recordings to user specified directory. Default operation is 
    to build menu entries for any recordings found.
9)  Foreign language accents in tags are handled (converted to the nearest 
    English equivalent). This is required by the Neuros as it doesn't 
    support accents.
10) Crossplatform support (works with latest ActivePerl on Windows). This 
    isn't heavily tested.
11) Sub-menu support.
12) Various artist support. This feature allows the actual artist to appear 
    in the Now Playing and Info screens instead of "Various". This is nice 
    for soundtracks as a single soundtrack is typically made up of many 
    artists. Sorune support for this requires that the artist tag be "Various"
    and the title tag be "Title (Artist)".
    Examples:
      Artist = "Various"    Title = "Bogus Song (Joe Bob)"
      Artist = "Various"    Title = "Bogus Song (Remix) (Joe Bob)"
    In the Now Playing and Info screen, "Joe Bob" will appear as the artist.
    Unless you have a complete album by "Joe Bob", the artist will not appear 
    in the artists list. Only "Various" will appear thus leaving the artist 
    list uncluttered with single song artists.
13) Tag comparison support. This feature allows similar tags to be grouped
    together. For example, say you have the following genres: "Trip Hop",
    "Trip-Hop" and "TripHop". Setting the Tag Compare Genre to 1 will group
    all of these genres together since they all differ by 1 character. This 
    comparison is case insensitive.
14) Normalize support. This feature allows all database tags to be
    titlecased.

--------------
General Notes:
--------------
1) Sorune copies your local directory structure over directly. This has 
the benefit of maintaining the exact filenames and directory names as were 
stored on your local hard drive. This also means that it's not compatible 
with other synchronization managers.
2) Bugs do exist in Sorune and may be harmful to your computer and/or your
Neuros. Please read the LICENSE carefully before using Sorune.
3) Development on Sorune started with firmware release 2.11. As I never 
plan on reverting back to firmware 1.X, I have no idea if Sorune will 
work on that revision of firmware.

-------------
Installation:
-------------
Copy the files in the bin directory of this distribution to a location of 
your choosing. After running sorune, a configuration file will be created 
in your home directory (.sorunerc). You may edit this file for advanced 
configurations.

-----------------
External Modules:
-----------------
The following external module is required under Win32:
Win32::DriveInfo
   This module allows Sorune to determine the free space remaining on the
Neuros. It can be installed using ppm ("install Win32-DriveInfo").

The following external modules are optional, but highly recommended:
Compress::Zlib
   Installing this module will allow the Sorune database to be compressed 
on the backpack, saving valuable space and time. Depending on your 
distribution, this package might install with 'urpmi perl-Compress-Zlib'. 
This package is included with ActivePerl for Windows.

Tk
   The Sorune GUI is implemented in Perl Tk. This GUI allows you to 
easily manage your Neuros. Depending on your distribution, this package 
might install with 'urpmi perl-Tk'. This package is included with 
ActivePerl for Windows.

Note: No external modules are necessary if you are using the pre-built 
Win32 executable.

If not included with your distribution, these modules can be downloaded from 
http://www.cpan.org.  ActivePerl for Windows can be downloaded from 
http://www.activestate.com.

---------------
Running Sorune:
---------------
Rebuilding the Sorune database is the first thing you'll want to do. From that 
point on, you may issue adds and deletes. Be sure to Sync when you're done.

-------------
Contributors:
-------------
Darren Smith              (main program/libraries)
Andrew Molloy/Dave Brown  (ogg pureperl module, via cpan.org)
Chris Nandor              (mp3 module, via cpan.org)
Yuval Kojman              (mp3frame module, via cpan.org)
Daniel Sully              (wma module, via cpan.org)
Nick Peskett              (wav module, via cpan.org)
Kurt George Gjerde        (wav module, via cpan.org)
Matthias Halibrand        (Sorune Icons)
Anthony DeRobertis        (Unicode support for non-windows platforms)
Dave Hayes                (FreeBSD support)
Kevin Smith               (Sorune Logo)
Jan Depner                (Bugfix)

----------------
Acknowledgments:
----------------
First and foremost, I'd like to thank Digital Innovations, LLC. for the 
best digital audio player available. You guys rock! I'd also like to thank 
xiph.org for the Neuros database information. The information gleaned 
from that site made this program possible. Also, thanks to all the module
contributors for indirectly helping with this project. Lastly, thanks to 
you for actually reading this document, trying this out and sending in bug
reports. :)
