QuickRip v0.8 README
-------------------

http://quickrip.sf.net/

1. PREAMBLE
2. INSTALLATION
3. HOW TO USE
4. FEEDBACK
5. LICENSE

1. PREAMBLE
------------
Hullo, welcome to QuickRip, a quick and easy DVD Ripping app for GNU/Linux.
I've written this purely for fun, and because I didn't like any of the DVD
rippers already available. If you have problems, I might be able to help,
but I don't promise anything.

THIS COMES WITH NO WARRANTY! Check the LICENSE file to find out more about
the GNU General Public License under which this is released.


2. INSTALLATION:
----------------
Ensure you have Python (>= 2.2), Qt (>= 3.1), PyQt (>= 3.5), Mplayer and
Transcode installed. The installation script will check that you've got these 
components, so don't worry if you're not sure.

Mplayer will also need to be compiled with libmp3lame support.  Transcode
should be compiled with libdvdcss support.  This is accomplished in both
instances by compiling MPlayer or Transcode after you've compiled and
installed libmp3lame and libdvdcss.

Once you've satisfied Quickrip's dependencies, you simply do this:

  hostname$ sh install.sh

And let it set things up for you :) Once it's finished, you can run QuickRip
by executing "quickrip". If install.sh fails for any reason, just manually copy
the files to /usr/share/quickrip, and create a symbolic link from 
/usr/share/quickrip/quickrip.py to /usr/bin/quickrip, like so:

  hostname$ mkdir -p /usr/share/quickrip
  hostname$ cp *.py *.ui LICENSE README quickriprc /usr/share/quickrip
  hostname$ ln -sf /usr/share/quickrip/quickrip.py /usr/bin/quickrip



3. HOW TO USE:
--------------
hostname$ quickrip --help
QuickRip v0.8, (C) Tom Chance, 2003

Usage: /usr/bin/quickrip [options]

Options:  (with none, runs PyQt GUI mode)
    -h, --help              print this help message
    -c, --cli                 run in command line interface mode
    -a, --autoresize     automatically resize the cli progress bar as
                                the terminal is resized (small performance hit)

Hopefully it's very easy and obvious to use GUI QuickRip - that is the main purpose
afterall. Basically, you "Scan DVD", wait until it's finished, then select the tracks 
you want to rip, and set the options for how they will be ripped. Each track will 
have its own set of options, so you need to select each track and set its options 
in turn. You can change the names of tracks by right-clicking on their name at 
present (by default: 01, 02, etc.)

Once you're ready, hit the "Rip DVD" button, and then click on "Start". You can 
stop and start the process at any time, but at present you cannot resume the 
process, so stopping and starting will make the process start all over again.

To run with the command line interface (CLI), simply run as "quickrip -cli" and 
follow the on-screen instructions to rip your DVD :)

For a more thorough user guide, consult the online documentation at:
http://quickrip.sf.net/docs.shtml


4. FEEDBACK:
------------
QuickRip is bound not to do exactly what you want it to do, and you might even 
have problems using it, so if you have any suggestions of how I could 
improve it, or any bugs to report, give me your ideas! Details can be 
found on the QuickRip web page:

http://quickrip.sf.net/



5. LICENSE:
-----------
All code in QuickRip is copyrighted by Tom Chance, 2003, and released under the 
GNU General Public License v2, included in this package as the file "LICENSE", 
except for 'output.py', which is copyright Daniel Robbins, Gentoo Technologies 
Inc., 1998-2003, and which is also released under the GNU General Public License 
v2.

As such, under the terms of the GPL, you are free to copy, modify and redistribute
QuickRip as you like, so long as the code remains under the GPL, and is released to 
the public under these same terms. Copyright always remains with Tom Chance. Please 
notify Tom Chance of any forks you make (visit the QuickRip homepage for contact 
details).
