Add command line option support

[rpmbased-dist-chroot.git] / README

diff --git a/README b/README
index e96f8ea584664fda4f4763732da24069cf2107d0..90a9e829c97335e59191b1d16e98278bbb226125 100644 (file)
--- a/README
+++ b/README
@@ -20,5 +20,19 @@ Copy the file rpmbased-dist-chroot.sh to a directory in your PATH.
 
 Usage
 -----
-Edit the script and change the variables at the top to point to the right
-places, run, rejoice!
+
+rpmbased-dist-chroot.sh --install-root /some/place/to/put/the/chroot \
+   --rpm-archives /path/to/CD/RPMS/directory --install-packages list of \
+   packages seperated by spaces
+
+All options are optional, if they're not specified then it uses the following
+defaults:
+       install-root    : /mnt/temp/fedora
+       rpm-archives    : /media/cdrom/Fedora/RPMS
+       install-packages: bash coreutils yum
+
+Author
+------
+Brett Parker:
+       email: <iDunno@sommitrealweird.co.uk>
+       www:   http://www.sommitrealweird.co.uk/