aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 11 insertions, 3 deletions
diff --git a/README b/README
index 2f4f79d..3942cbb 100644
--- a/README
+++ b/README
@@ -3,9 +3,14 @@ README for miragextract v0.1.0
Description
-----------
-Extracts data and audio tracks from any CD image supported by libmirage.
-Data tracks are written as-is, and audio tracks can be written as-is
-or converted to wav, flag, or ogg/vorbis (via libsndfile).
+A pair of tools for working with CD image files.
+
+miragextract extracts data and audio tracks from any CD image supported
+by libmirage. Data tracks are written as-is, and audio tracks can be
+written as-is or converted to wav, flag, or ogg/vorbis (via libsndfile).
+
+cuerecover attempts to create a .cue file for .bin files whose .cue
+files are missing.
Prerequisites
-------------
@@ -24,6 +29,9 @@ If you're on a system that has separate "dev" or "devel" packages
If you for some reason need to rebuild the man and html pages, you'll
need docutils (I used 0.14).
+If you *just* want cuerecover, you don't need libmirage nor libsndfile.
+Run "make cuerecover" in this case.
+
Installation
------------
To build, run "make" (might be spelled "gmake" on your OS). To install,