0.0.1 release

3 files changed, 61 insertions, 15 deletions

diff --git a/FAQ b/FAQ
index 16c5dde..09ccfc3 100644
--- a/FAQ
+++ b/FAQ
@@ -62,3 +62,9 @@ or libsndfile. Porting to other OSes will require more knowledge of those OSes
 Q9. Can I use it with real CDs?
 A9. No. libmirage doesn't support reading real CDs. Use regular CD-ripping
 software to get audio tracks, and 'dd' to extract an iso image.
+
+Q10. I'm trying to use miragextract to extract an ISO and ...
+A10. Let me stop you right there: you're using the wrong tool for the job
+you're trying to do. libmirage will accept an ISO as input, but all it
+can 'extract' from it is a copy of the ISO itself. You probably want to
+mount your ISO to extract files from it.
diff --git a/Makefile b/Makefile
index 92ae3fa..22766e5 100644
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,7 @@
 # Makefile for miragextract
 
 ####
-# Packagers: override these the make command line as needed.
+# Packagers: override these on the make command line as needed.
 
 # Intended for optimizations, but you could include other flags here.
 OPTFLAGS=-O2
@@ -21,9 +21,21 @@ DESTDIR=
 STRIPBIN=y
 GZIPMAN=y
 
+# Normally these will end up as root and root (or possibly wheel). You
+# could also set 'CHOWN=/bin/true' to skip it.
+OWNER=$(shell id -u 0)
+GROUP=$(shell id -ng 0)
+
+# These are only used if you're rebuilding the man and/or html pages,
+# e.g. because you've patched them.
+RST2MAN=rst2man.py
+RST2HTML=rst2html4.py
+
 #
 ###
 
+# Hopefully, no user-serviceable parts below this line.
+
 PROJ=miragextract
 DOCS=README FAQ ChangeLog $(PROJ).html
 
@@ -42,19 +54,11 @@ man: $(PROJ).1
 
 html: $(PROJ).html
 
-test: all
-	./$(PROJ) test.cue
-
-push: all man html
-	git add $(PROJ).1 $(PROJ).html
-	git commit -m'auto-regenerate man/html pages' || true
-	git push
-
 $(PROJ).1: $(PROJ).rst
-	rst2man.py $(PROJ).rst > $(PROJ).1
+	$(RST2MAN) $(PROJ).rst > $(PROJ).1
 
 $(PROJ).html: $(PROJ).rst
-	rst2html4.py $(PROJ).rst > $(PROJ).html
+	$(RST2HTML) $(PROJ).rst > $(PROJ).html
 
 ifeq ($(shell whoami),root)
 CHOWN=chown
@@ -79,7 +83,16 @@ endif
 	for i in $(DOCS); do \
 		cp $$i $(DESTDIR)$(DOCDIR); \
 		chmod 644 $(DESTDIR)$(DOCDIR)/$$i; \
-		$(CHOWN) root:root $(DESTDIR)$(DOCDIR)/$$i; \
+		$(CHOWN) $(OWNER):$(GROUP) $(DESTDIR)$(DOCDIR)/$$i; \
 	done
 
+# These 2 are maintainer-specific targets.
+test: all
+	./$(PROJ) test.cue
+
+push: all man html
+	git add $(PROJ).1 $(PROJ).html
+	git commit -m'auto-regenerate man/html pages' || true
+	git push
+
 .PHONY: all man html test push install
diff --git a/README b/README
index 6369c03..48b0f0f 100644
--- a/README
+++ b/README
@@ -7,11 +7,25 @@ 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).
 
-Installing
-----------
+Prerequisites
+-------------
 Requires GNU make, libmirage >= 3.0.0 and libsndfile (tested with 1.0.26,
-other recent-ish versions should work).
+other recent-ish versions should work). Since libmirage uses glib2,
+you'll need that as well.
 
+For libsndfile to create flac and ogg files, it has to have been
+built with support for them, which should only be a concern if you're
+building libsndfile yourself (distro packages should have ogg/flac
+support already).
+
+If you're on a system that has separate "dev" or "devel" packages
+(e.g. libmirage and libmirage-dev), you'll want the "dev" packages.
+
+If you for some reason need to rebuild the man and html pages, you'll
+need docutils (I used 0.14).
+
+Installation
+------------
 To build, run "make" (might be spelled "gmake" on your OS). To install,
 "make install". Near the top of the Makefile are some variables you
 can override on the make command line to control where everything gets
@@ -65,3 +79,16 @@ http://urchlay.naptime.net/repos/miragextract/
 
 If this doesn't help, contact me by email (see above) and I'll see what
 I can do.
+
+Acknowledgments
+---------------
+The idea for miragextract came from John Oyler, who asked "Why do I
+need separate utilities for all these different CD image formats? Why
+couldn't there be a single tool that knows them all?"
+
+miragextract stands on the shoulders of giants:
+
+Erik de Castro Lopo is the main author of libsndfile, along with a long
+list of contributors.
+
+Rok Mandeljc and Henrik Stokseth are the authors of libmirage.