Correct homepage URL in README
[abcde.git] / README
diff --git a/README b/README
index 2494e29..6888486 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,9 @@ ABCDE
 =====
 
 abcde is a frontend command-line utility (actually, a shell script) that
-grabs tracks off a CD, encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or
-MPP/MP+(Musepack) format, and tags them, all in one go.
+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
@@ -15,22 +16,51 @@ abcde.conf to change it.
 
 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 
-for help.
-
-To make abcde 2.x work more like 1.x, put these options in your abcde.conf:
-
-INTERACTIVE=n
-OUTPUTTYPE=mp3
-ID3TAGV=1
+for more help.
 
 MAJOR CHANGES
 =============
 Changes in 2.4:
-* Support for mkcue, to create a CUE sheet of the CD structure.
+* Read TOC entries from the CD. The default uses cdrdao. The program mkcue is
+  also optional.
+* Possibility to use CDDBCHOICE1,CDDBCHOICE2 (i.e., 1,3) to get a diff of two
+  parsed CDDB entries.
+* Added SHOWCDDBFIELDS to define wether to show the YEAR and GENRE fields from
+  the CDDB output.
+* 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
+  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).
+* Added replaygain for Ogg/Vorbis and Ogg/FLAC.
+* Added M4A encoding.
+* Uses the default found $CDROMREADER instead of forcing cdparanoia when
+  cdda2wav is installed.
+* BATCH mode has been splitted into two options: BATCHNORM and NOGAP.
+* Added -U option for non-UNICODE (non UTF-8) tag encoding.
+* Added -z for debug.
+* Added -f to force the removal of left files.
+* CUE support has changed from a flag (-M) to an action (cue).
+Changes in 2.3:
+* Support for mkcue, to create a CUE sheet of the CD structure. It can be used
+  with "-1" to create a backup, so that later the original CD can be recreated.
 * New -o <output(1)>:<options(1)>,... way of passing specific options to an
   output. Now we can pass specific options without having to modify a config
-  file.
-* Unix PIPEs, as a second way to encode files with a tight disc space.
+  file. This feature was already present in the last versions of the 2.2 cycle.
+* Unix PIPEs, as a second way to encode files with a low disc space.
+* Option to erase the "encoded" entries from the status file. Allows one to
+  encode the wav files (in case they were not erased) into another format. This
+  is needed until status information is stored for each format.
+* The "ogg" output mode will be substituted for "vorbis" in the near future.
+  This release adds a compatibility layer so that both entries work.
+* The FLAC encoder forces the files to be overwritten, in case they previously
+  exists. This avoids a half-through abcde run to continue without errors in
+  case it was cancelled during the FLAC encoding.
+* Added a post_read() function so that we can do things with the CD before we
+  eject it.
 
 Changes in 2.2:
 
@@ -173,11 +203,12 @@ abcde requires the following backend tools to work:
     http://www.iis.fhg.de/amm/download/ or:
 * FLAC encoder (flac) or:
 * Ogg/Speex encoder (speexenc) or:
-* MPP/MP+(Musepack) encoder (mppenc)
+* MPP/MP+(Musepack) encoder (mppenc) or:
+* AAC encoder (faac)
 * normalize-audio for volume normalization.
-* CD Paranoia, an audio CD reading utility,
-* Or cdda2wav, the audio CD reading utility cdparanoia was born from,
-* Or dagrab, another audio CD reading utility.
+* CD Paranoia, an audio CD reading utility or:
+* cdda2wav, the audio CD reading utility cdparanoia was born from 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://www.hispalinux.es/~data/files/cd-discid/
 * An HTTP retrieval program: wget, fetch (FreeBSD) or curl (MacOSX)
@@ -190,13 +221,11 @@ Abcde's new mailing list is abcde@listas.hispalinux.es. So far has not
 been actively used.
 The posts from non-subscribers are moderated to prevent spam.
 
-Archives of the old list are publically available at:
-http://lly.org/~rcw/abcde/list/current/threads.html
+Abcde's current page is at http://code.google.com/p/abcde/
 
-Abcde's current page is at http://www.hispalinux.es/~data/abcde.php
-Abcde's old homepage is at http://lly.org/~rcw/abcde/page/.
 --
 Jesus Climent <jesus.climent@hispalinux.es>
+Colin Tuckley <colint@debian.org>
 
 abcde was originally created by Robert Woodcock <rcw@debian.org>