1---------------------------------------------------------------
2| id3 mass tagger v0.80
3-------------------------------------------------------------
4
5the contents of the source distribution:
6
7 COPYING        - license
8 INSTALL        - ... ? :)
9 README         - program documentation
10 CHANGES        - changelog
11
12 makefile       - generic (gnu) makefile
13 makefile.dj    - makefile for djgpp2
14 makefile.bcc   - makefile for borland c++
15 makefile.nmk   - makefile for microsoft c++
16
17 main.cpp       - main program file                             (C++)
18 id3-images.c   - auxiliary program to extract album art        (C)
19 pattern.*      - + automatic variables                         (C++)
20 dumptag.*      - + save/reading tag info                       (C++)
21 sedit.*        - string formatting                             (C++)
22 set_base.h     - abstract patch class                          (C++)
23 setid3.*       - + id3v1 implementation                        (C++)
24 getid3.*       - + id3v1 reader                                (C++)
25 setid3v2.*     - + id3v2 implementation                        (C++)
26 getid3v2.*     - + id3v2 reader                                (C++)
27 setlyr3.*      - + lyrics3 implementation                      (C++)
28 getlyr3.*      - + lyrics3 reader                              (C++)
29 setfname.*     - + file renamer/handler                        (C++)
30 setquery.*     - + stdout formatter                            (C++)
31 setgroup.h     - + combiner                                    (C++)
32 varexp.*       - wildcard/pattern matching class               (C++)
33 fileexp.*      - filefinder/matcher                            (C++)
34 mass_tag.*     - + tagging engine                              (C++)
35 charconv.*     - character conversion                          (C++)
36 char_ucs.*     - + utf16 encoding                              (C++)
37 char_utf8.*    - + utf8 encoding                               (C++)
38 utf8.h         - stand-alone utf8 encoder/decoder              (C++)
39 auto_dir.h     - smart dirent pointer class                    (C++)
40
41 id3v1.*        - definitions & data relevant to ID3v1 tag data (C)
42 id3v2.*        - basic ID3v2 reading/writing interface         (C)
43 fileops.*      - auxiliary file functions                      (C)
44 lyrics3.*      - Lyrics3v2 interface                           (C++)
45
46 id3.man        - raw man page                                  (troff -man)
47
48 debian/        - Debian files for creating a .deb package
49 rpm/           - RPM specfile for creating a .rpm package
50 bash/          - definitions for bash auto-completion
51
52---------------------------------------------------------------
53| (c) squell 2003-2015 - copyright notice
54-------------------------------------------------------------
55
56All files in this package are copyrighted. This is NOT public domain software.
57
58This software comes under a FreeBSD style license, which (in short) means you
59can pretty much do with it as you please (including redistribution under
60another license such as the GNU GPL), as long as copyright is acknowledged.
61
62It also means you can't sue me if anything terrible happens.
63
64For the actual licensing conditions you should read the file 'COPYING',
65which should be included in this source distribution.
66
67---------------------------------------------------------------
68| building and installing using a package manager
69-------------------------------------------------------------
70
71Files are included for building packages for .deb and .rpm-based Linux
72distributions, and FreeBSD. The package will identify itself as `id3mtag'.
73
74* .deb (Debian/Ubuntu)
75
76From the source tree, run:
77> dpkg-buildpackage -b
78
79This should create a .deb file in the parent directory.
80
81* .rpm (Fedora/CentOS)
82
83The simplest way is to simply run:
84> rpmbuild -ta id3-0.80.tar.gz
85
86Then look in your RPM build area ($HOME/rpmbuild)
87
88* FreeBSD
89
90Install audio/id3mtag from the ports collection.
91
92---------------------------------------------------------------
93| building and installing manually
94-------------------------------------------------------------
95
96Successfully compiled with (non-exhaustive list):
97
98 - GCC 4.x, 5.0
99 - Clang 3.x
100 - Microsoft C/C++ 16.x/18.x
101 - Borland/Embarcadero C++ 5.5/6.90
102 - Oracle/Sun C++ 5.13, using STLport4
103 - Intel C++ 14.0.2
104
105This program is written to be portable, assuming at least a C90 and C++03
106compiler and a POSIX:2001 environment. Compilation shouldn't be hard.
107
108Notes for building under Windows:
109
110 * When using MSVC, the file 'dirent.h' is not included with the compiler. You
111   can use the open source replacement by Toni Ronkko, obtainable at
112   https://github.com/tronkko/dirent/
113
114 * With MinGW, you need to add LDFLAGS="-static-libgcc -static-libstdc++" to
115   the mingw32-make commandline if you want to execute the resulting binary
116   on a machine without MinGW installed.
117
118===
119Makefiles
120
121Pick the makefile you need and rename it to 'makefile' or use 'make -f':
122
123  'makefile'  is meant for generic GNU/BSD systems. You can also use this
124  file for building with Cygwin or MinGW.
125
126  Please note that CFLAGS/CXXFLAGS/LDFLAGS set in your environment will
127  override the default (recommended) flags provided in this makefile.
128
129  'makefile.dj'  is for DOS systems using DJGPP v2
130
131  'makefile.nmk'  is for building a Win32 executable with VisualStudio `nmake'
132
133  'makefile.bcc'  is for building a Win32 executable with C++Builder `make'
134
135===
136Standard makefile targets:
137
138 make                 - builds the program
139 make clean           - removes all files produced by make
140
141Generic GNU/BSD makefile targets & variables:
142
143 make install         - installs the program
144 make install-strip   - like install, but strips executable of debug info
145 make install-full    - also installs the documentation in $(datadir)/doc
146 make uninstall       - uninstall (does not remove documentation)
147 make bash_completion - installs the bash completion support
148 make help            - lists all makefile targets and variables
149
150Because id3 does not have a configure script (yet), you can set
151these variables only on the 'make' commandline:
152
153 prefix               - the prefix directory       (def. "/usr/local")
154 bindir               - dir for binaries           (def. "$(prefix)/bin")
155 mandir               - dir for manpages           (def. "$(prefix)/man")
156 datadir              - dir for shared files       (def. "$(prefix)/share")
157 binary               - the binary to install      (def. "id3")
158 DESTDIR              - used for staged installs   (def. "")
159
160E.g: "make install prefix=$HOME" to install in $HOME/bin instead. See inside
161'makefile' or try `make help' for more details (and more variables).
162
163---------------------------------------------------------------
164| useful links
165-------------------------------------------------------------
166
167(Win32) Minimalist GNU for Windows:
168  http://www.mingw.org/
169
170---------------------------------------------------------------
171| contact: squell@alumina.nl
172-------------------------------------------------------------
173
174