Major refactoring of the DVD encoding algorithms:

[rip_dvd/.git] / README

diff --git a/README b/README
index 84d53a53c964481c8ed4ea3bd407b90e2a64db71..33f8b10b19c00cd634abba97b58302dd9d38a146 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,17 @@
+----------------------------------------------
+DEPENDENCIES
+----------------------------------------------
+The following packages need to be installed on your system:
+
+Package Dependencies (apt-get install these for example):
+lsdvd dvdauthor gddrescue dvdbackup tovid mencoder mplayer genisoimage libdvdcss2
+
+Specific Executable (program) Dependencies (must be found in $PATH):
+volname makexml lsdvd dvdauthor gddrescue dvdbackup mencoder mplayer mkisofs
+
+Optional Dependencies:
+lookup imdb info/posters for mythvideo: http://www.mythtv.org/wiki/Fill_mythvideo_metadata.pl
+
 ----------------------------------------------
 INSTALL
 ----------------------------------------------
@@ -23,3 +37,59 @@ file you create locally.  This will allow you to get updates from my
 GIT repository at a later point in time without blowing away your 
 local settings.
 
+----------------------------------------------
+MYTHTV MENU SETUP
+----------------------------------------------
+Copy the menu files provided in the GIT repository to your mythtv
+menu location:
+
+> cp optical_menu.xml /usr/share/mythtv/
+> cp rip_dvd_menu.xml /usr/share/mythtv/
+
+You'll also need to edit the rip_dvd_menu.xml file so that the paths,
+commands, buttons, actions, meet your needs to accomplish the common
+encoding tasks you will want to do.
+
+The optical_menu.xml file was modified with a single entry for the
+rip_dvd_menu.xml file. You can take a look at this entry in this file
+and place it in any xml file you want to get it on the menu you want.
+I choose to place it on the optical menu.
+
+----------------------------------------------
+COMMAND LINE EXAMPLES
+----------------------------------------------
+
+Rip a DVD into a compressed AVI file with default hdtv profile:
+> rip_dvd -d /path/to/dest/dir -b 2000 -x
+
+Rip a DVD into a compressed AVI file with default hdtv profile scaling to 320x240 compressed video size:
+> rip_dvd -d /path/to/dest/dir -b 2000 -x -a 320:240
+
+Rip a DVD into a compressed AVI file with default hdtv profile targetting a certain compressed video filesize (in MB):
+> rip_dvd -d /path/to/dest/dir -b 2000 -x -s 650
+
+Rip a DVD into a VOB file:
+> rip_dvd -d /path/to/dest/dir -v
+
+Rip a DVD into an ISO file:
+> rip_dvd -d /path/to/dest/dir -m
+
+Rip a DVD into a burnable DVD compliant folder (creating VIDEO_TS and AUDIO_TS folders):
+> rip_dvd -d /path/to/dest/dir -f
+
+Rip a VOB file into a compressed AVI file:
+> rip_dvd -d /path/to/dest/dir -b 2000 -x -n /path/to/file.vob
+
+Rip a DVD Folder into a compressed AVI file:
+> rip_dvd -d /path/to/dest/dir -b 2000 -x -n /path/to/dvd/folder/that/contains/a/VIDEO_TS
+
+Rip a DVD into a compressed MP4 file for an ipod:
+> rip_dvd -d /path/to/dest/dir -b 2000 -x -p ipod
+
+Rip a DVD into a compressed MP4 file for an ipod AND again for a compressed AVI file:
+> dvdname=`volname /dev/dvd | awk '{ print $1 }'`
+> rip_dvd -d /path/to/dest/dir -v
+> rip_dvd -d /path/to/dest/dir/ipod -b 2000 -x -p ipod -n /path/to/dest/dir/$dvdname.VOB
+> rip_dvd -d /path/to/dest/dir/hdtv -b 2000 -x -p hdtv -n /path/to/dest/dir/$dvdname.VOB
+> rm /path/to/dest/dir/$dvdname.VOB
+