Fix Musicbrainz ID calculation in makeids()
[abcde.git] / README
diff --git a/README b/README
index c6d6258..874aea2 100644 (file)
--- a/README
+++ b/README
@@ -2,24 +2,72 @@ ABCDE
 =====
 
 abcde is a frontend command-line utility (actually, a shell script) that
-grabs tracks off a CD or a singletrack flac file with an embeded cuesheet,
-encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack)
-format, and tags them, all in one go.
-
-Your finished Ogg/MP3/FLAC/Speex/MPP's are, by default, stored in a subdirectory
-of the current directory (named after the artist) with a filename based on the
-track title. Spaces are replaced by underscores, and apostrophes and control
-codes are filtered out. Colons are replaced with an underscore and a hyphen. The
-end result usually looks like: Our_Lady_Peace/01.Supermans_Dead.ogg This
-filename munging is customizable - edit the mungefilename function in your
-abcde.conf to change it.
+grabs tracks off a CD or a singletrack flac file with an embedded cuesheet,
+encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, M4A, Opus, WavPack,
+Monkey's Audio (ape), MPP/MP+(Musepack) and/or AIFF format, and tags
+them, all in one go.
+
+Your finished Ogg/MP3/FLAC/Speex/M4A/Opus,WavPack/Ape/MPP/AIFF's are, by default,
+stored in a subdirectory of the current directory (named after the artist)
+with a filename based on the track title. Spaces are replaced by underscores,
+and apostrophes and control codes are filtered out. Colons are replaced with
+an underscore and a hyphen. The end result usually looks like:
+Our_Lady_Peace/01.Supermans_Dead.ogg. This filename munging is customizable,
+edit the mungefilename function in your abcde.conf to change it.
+
+abcde also has the ability to search for and download suitable album art as
+well as automatically embed the album art into the tracks of some containers.
 
 Many of the questions related of problems executing abcde have been moved to the
-FAQ, which should be distributed along with this package. Reffer to that file
+FAQ, which should be distributed along with this package. Refer to that file
 for more help.
 
 MAJOR CHANGES
 =============
+
+Changes in 2.8.1
+* Fix for stupid bug introduced in abcde-musicbrainz-tool in 2.8
+
+Changes in 2.8
+* Add support for using multiple CD lookup services in order
+* Switch from cddb to musicbrainz as the default CD lookup service
+* Lots more bugs fixes - see the changes for more details.
+
+Changes in 2.7.2
+* Support for output to the Matroska container (mka).
+* Add id3tag mp3 tagger as this is the tagger available to
+  OpenBSD users. 
+* Several bug fixes. See the changelog for more details.
+
+Changes in 2.7.1
+* Rewrite and improvement of the abcde Makefile.
+* Support added for True Audio encoding.
+* Support added for encoding to MPEG-1 Audio Layer II (mp2) with either
+  twolame or FFmpeg.
+* Support added for encoding to WavPack with FFmpeg.
+* Support added for encoding to m4a with either FFmpeg or avconv. This
+  allows usage of the FFmpeg / avconv native alac encoder.
+* Support added for AAC encoding with fhgaacenc via Wine.
+* Support added for AAC encoding with qaac via Wine. (Also alac encoding
+  with the open source refalac).
+* Several bug fixes. See the changelog for more details.
+
+Changes in 2.7
+* Rewrite of the mungefilename function.
+* Support added for downloading album art.
+* Support added for ripping with libcdio (cd-paranoia).
+* Some error checking and a small help file added to abcde-musicbrainz-tool. 
+* Substantial renovations of m4a encoding with a choice now between encoding
+  with faac, NeroAacEnc and fdkaac.
+* Fixes to USEPIPES with the addition of several new encoders and rippers.
+  Details on USEPIPES now available in the abcde FAQ doc.
+* Support added for encoding with Monkey's Audio (ape), tagging is with
+  Robert Muth's apetag.
+* Support added for encoding with WavPack.
+* mp3 tagging renovated with version sniffing differentiating between eyeD3
+  versions. Tagging formalised with options now for id3, id3v2 and eyeD3.
+* Many, many bug fixes. See the changelog for more details.
+
 Changes in 2.6:
 * Lots of bugfixes
 
@@ -36,7 +84,7 @@ Changes in 2.4:
 * Added the possibility of embeding a cuesheet on a singletrack flac file. A
   single BACKUP flag is most likely needed to use all the needed flags:
   "abcde -1 -o flac -a default,cue"
-* Added the possibility of using a singletrack flac file with an embeded
+* Added the possibility of using a singletrack flac file with an embedded
   cuesheet as a source to extract tracks from (use -X to specify an external
   CUE2DISCID implementation; check under examples in the distributed source
   code or package).
@@ -199,21 +247,18 @@ REQUIREMENTS
 abcde requires the following backend tools to work:
 
 * An Ogg/Vorbis encoder (oggenc, the default, or vorbize) or:
-* An MP3 encoder (lame, gogo, bladeenc, l3enc, etc). Any MP3 encoder that
-  takes two filenames on the command line, one for input, one for output,
-  will work.
-  You can get lame at: http://www.mp3dev.org/mp3/
-  You can get gogo at: http://homepage1.nifty.com/herumi/gogo_e.html
-  You can get BladeEnc at: http://bladeenc.mp3.no/
-  You can get a trial version of mp3enc at:
-    http://www.iis.fhg.de/amm/download/ or:
-* FLAC encoder (flac) or:
-* Ogg/Speex encoder (speexenc) or:
-* MPP/MP+(Musepack) encoder (mppenc) or:
-* AAC encoder (faac)
+* An MP3 encoder (lame, gogo, bladeenc, l3enc, etc) or:
+* A FLAC encoder (flac) or:
+* An Ogg/Speex encoder (speexenc) or:
+* An MPP/MP+(Musepack) encoder (mpcenc) or:
+* An AAC encoder (faac, NeroAacEnc, fdkaac) or:
+* An Opus encoder )opusenc) or:
+* A Monkey's Ausio encoder (mac) or:
+* A WavPack encoder (wavpack)
 * normalize-audio for volume normalization.
 * CD Paranoia, an audio CD reading utility or:
 * icedax/cdda2wav, the audio CD reading utility cdparanoia was born from or:
+* cd-paranoia, an audio cd reading utility, courtesy of GNU libcdio or:
 * dagrab, another audio CD reading utility.
 * cd-discid, a CDDB DiscID reading program. Formerly bundled with abcde.
   It's available in Debian or http://linukz.org/cd-discid.shtml
@@ -223,19 +268,18 @@ abcde requires the following backend tools to work:
 * (optional) distmp3, a client/server for distributed mp3 encoding.
   You can get distmp3 at http://wlug.westbo.se/medlprog/medlprog.html
 
-Abcde's new mailing list is abcde-users@lists.einval.com. Visit
+Abcde's mailing list is abcde-users@lists.einval.com. Visit
 
-  http://lists.einval.com/cgi-bin/mailman/listinfo/abcde-users
+  https://lists.einval.com/cgi-bin/mailman/listinfo/abcde-users
 
 to subscribe. Posts from non-subscribers are moderated to prevent
 spam.
 
-Abcde's current page is at http://abcde.einval.com/ and the latest
-upstream code is in git at http://git.einval.com/cgi-bin/gitweb.cgi?p=abcde.git
+Abcde's current page is at https://abcde.einval.com/ and the latest
+upstream code is in git at https://git.einval.com/cgi-bin/gitweb.cgi?p=abcde.git
 
 --
-Jesus Climent <jesus.climent@hispalinux.es>
-Colin Tuckley <colint@debian.org>
 Steve McIntyre <93sam@debian.org>
+Andrew Strong <andrew.david.strong@gmail.com>
 
 abcde was originally created by Robert Woodcock <rcw@debian.org>