Add README.md

README.md

@@ -0,0 +1,64 @@
+NRGrip - extract audio track and cue sheet from an NRG audio CD image
+=====================================================================
+
+This program works on a Nero Burning ROM's NRG image of an audio CD and is able
+to:
+
+- read and display its metadata;
+
+- extract the cue sheet;
+
+- extract the raw audio tracks as one single file, which can then be encoded by
+  the user to a more convenient audio format such as FLAC, and possibly split
+  according to the cue sheet.
+
+For now, only NRG v2 is handled (not NRG v1), and not all of the metadata chunks
+are decoded. If you have interest in adding support for additional chunks or
+formats and have a test image handy, please contact the author or open a
+ticket. In particular, it would be interesting to support ISRC/CD-Text; handling
+of multisession and hybrid (audio and data) discs would also be a nice feature.
+
+NRGrip is licensed under the terms of the Expat (MIT) license. See the `COPYING`
+file.
+
+
+Installing
+----------
+
+NRGrip is written in Rust. Make sure [Cargo](http://doc.crates.io/) is installed
+on your system, then:
+
+    cargo build --release
+    cargo install
+
+
+Usage
+-----
+
+At the moment, NRGrip doesn't take any options, you just invoke it with the name
+of an NRG image:
+
+    nrgrip image.nrg
+
+The cue sheet will be extracted as `image.cue`, and the audio data as
+`image.raw`.
+
+To play the extracted raw audio data, you may use `aplay`, from the ALSA utils
+(you can also do that directly on the NRG file):
+
+    aplay -f cd image.raw
+
+To encode the raw audio data to FLAC (and embed the cue sheet in it):
+
+    flac --endian=little --sign=signed --channels=2 --bps=16 \
+      --sample-rate=44100 --cuesheet=image.cue image.raw
+
+To split the FLAC file according to the cue sheet, you may use,
+[cuetools](https://github.com/svend/cuetools) and
+[shntool](http://www.etree.org/shnutils/shntool/):
+
+    cuebreakpoints image.cue | shnsplit -o flac image.flac
+
+Or [mp3splt](http://mp3splt.sourceforge.net/):
+
+    mp3splt -c image.cue image.flac