add README

1 files changed, 20 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..97fa814
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+miragextract
+
+Extracts data and audio tracks from any CD image supported by libmirage.
+
+One day, it will work like this:
+
+Usage: miragextract [-t track] [-b basename] [-f cdda|wav|ogg|flac] image-file
+
+-t takes a track number, and extracts only that one track. Default
+behaviour is to extract all tracks.
+
+-b sets the basename for the output files. Default is 'track'.
+
+-f sets the format and filename extension for the output files. Default is
+'wav'. "cdda" files are raw CD audio samples.
+
+Output files will be named e.g. track01.wav, track02.wav.
+
+Requires libmirage >= 3.0.0 and libsndfile (tested with 1.0.26, other
+versions should work).