---------------------------------------------------------------
| id3 mass tagger v0.77
-------------------------------------------------------------

the contents of the source distribution:

 COPYING        - license
 INSTALL        - ... ? :)
 README         - program documentation
 CHANGES        - changelog

 makefile       - generic (gnu) makefile
 makefile.dj    - makefile for djgpp2
 makefile.bcc   - makefile for borland c++

 main.cpp       - main program file                             (C++)
 pattern.*      - + automatic variables                         (C++)
 sedit.*        - string formatting                             (C++)
 set_base.*     - abstract patch class                          (C++)
 setid3.*       - + id3v1 implementation                        (C++)
 getid3.*       - + id3v1 reader                                (C++)
 setid3v2.*     - + id3v2 implementation                        (C++)
 getid3v2.*     - + id3v2 reader                                (C++)
 setfname.*     - + file renamer                                (C++)
 setecho.*      - + stdout formatter                            (C++)
 varexp.*       - wildcard/pattern matching class               (C++)
 fileexp.*      - filefinder/matcher                            (C++)
 mass_tag.*     - + tagging engine                              (C++)
 charconv.*     - character conversion                          (C++)
 char_ucs.*     - + ucs2 encoding                               (C++)
 auto_dir.h     - smart dirent pointer class                    (C++)

 id3v1.*        - definitions & data relevant to ID3v1 tag data (C)
 id3v2.*        - basic ID3v2 reading/writing interface         (C)
 fileops.*      - auxiliary file functions                      (C)

 id3.man        - raw man page                                  (troff -man)

---------------------------------------------------------------
| (c) squell 2003-2006 - copyright notice
-------------------------------------------------------------

All files in this package are copyrighted. This is NOT public domain software.

This software comes under a Cryptix/BSD style license, which (in short) means
you can pretty much do with it as you please (including redistribution under
another license such as the GNU GPL), as long as copyright is acknowledged.

It also means you can't sue me if anything terrible happens.

For the actual licensing conditions you should read the file 'COPYING',
which should be included in this source distribution.

---------------------------------------------------------------
| building it on your system
-------------------------------------------------------------

Successfully compiled with (non-exhaustive list):

 - GCC 3.x, 4.0     (GNU/Linux, FreeBSD, Solaris, DJGPP, MinGW32)
 - GCC 2.95.x       (GNU/Linux, FreeBSD, DJGPP, MinGW32)
 - Intel C++ 8.1    (GNU/Linux)
 - Borland C++ 5.5  (Win32)
 - Compaq C++ 7.1   (Alpha)
 - Sun C/C++ 5.7    (SPARC)

This program is mostly written in 100% portable ISO C/C++ so basically all
you need is a modern, standards-compliant C/C++ compiler.

I recommend using DJGPP to build a 32bit DPMI program if you're using a
version of Windows 9X (e.g. 95, 98, Me) because of the kludgy support for
native Win32 console apps. Likewise, if you're using something based on NT
such as NT4, 2000 or XP, you should definitely build a native Win32 app.

===
Makefiles

Pick the makefile you need and rename it to 'makefile' or use 'make -f':

  'makefile'  is meant for generic GNU/BSD systems. You will have to edit it
  if you want to/need to use different settings. (You can also use this
  file for building with mingw32-make)

  The predefined CFLAGS and CXXFLAGS settings are tuned to gcc 3.x. Do not
  use -fno-rtti when compiling with gcc 2.95.

  'makefile.dj'  is for DOS systems using DJGPP v2

  'makefile.bcc'  is for building a Win32 executable for Borland C++ 5.5

===
Standard makefile targets:

 make id3           - fully enabled executable (default)
 make id3l          - id3v1 only executable
 make all           - both executables
 make final         - same as all, but tries to strip / pack the executables
 make clean         - removes all files produced by make

'final' assumes you have UPX (http://upx.sourceforge.net/) installed on
Win32/DOS systems. You should have. :)

Generic GNU/BSD makefile targets & variables:

 make install       - installs the program
 make install-strip - like install, but strips executable of debug info
 make install-full  - also installs the documentation in $(datadir)/doc
 make uninstall     - uninstall (does not remove documentation)
 make help          - lists all makefile targets and variables

Because id3 does not have a configure script (yet), you can set
these variables only on the 'make' commandline:

 prefix             - the prefix directory       (def. "/usr/local")
 bindir             - dir for binaries           (def. "$(prefix)/bin")
 mandir             - dir for manpages           (def. "$(prefix)/man")
 datadir            - dir for shared files       (def. "$(prefix)/share")
 binary             - the binary to install      (def. "id3")

E.g: "make install prefix=$HOME" to install in $HOME/bin instead. See inside
'makefile' or try `make help' for more details (and more variables).

---------------------------------------------------------------
| useful links
-------------------------------------------------------------

(DOS) DJGPP v2:
  http://www.delorie.com/djgpp/

(Win32) Borland C++ 5.5:
  ftp://ftpd.borland.com/download/bcppbuilder/freecommandLinetools.exe

(Win32) MinGW 2.0:
  http://www.mingw.org/

(Linux, Win32) Intel C++ 8.0:         (30 day evaluation/non-commercial only)
  http://www.intel.com/software/products/compilers/

(Win32 -> DOS extender)               (Use Win32 compilers to create DOS apps)
  http://michael.tippach.bei.t-online.de/wdosx/

---------------------------------------------------------------
| contact: (pri.) squell@goth.net, (alt.) squell@alumina.nl
-------------------------------------------------------------

