Commits

Thayne Harbaugh committed fb37689

Add installation and dependencies section to README.rst

Comments (0)

Files changed (3)

 =========
 
 MSC-Tools is a suite of tools for working with Mass Storage Class devices.
+
+
+Installation
+============
+
+MSC-Tools executables can be run from any location, however there are some
+(possibly unique) dependencies:
+
+  * ``pyudev``: Python bindings to libudev - used for manipulating udev
+    device information.
+
+  * ``partimage``: Partition imaging tool - used for the core work of
+    saving MSC partitions and cloning them.
+
+  * ``mdadm``: Linux RAID management tool - used for concurrently cloning
+    many MSC devices.
+
+  * ``sdparm``: SCSI device frobber - interacts with MSC devices which are
+    configured as SCSI block devices by Linux.
+
+
+
+.. _pyudev:    http://packages.python.org/pyudev/
+.. _partimage: http://www.partimage.org
+.. _mdadm:     http://neil.brown.name/blog/mdadm
+.. _sdparm:    http://sg.danny.cz/sg/sdparm.html
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'msc-tools', u'MSC-Tools Documentation',
+    ('msc-clone', 'msc-clone', u'MSC-Clone Documentation',
      [u'Thayne Harbaugh'], 1)
 ]
 .. _index:
 
-.. include:: ./../README.rst
-
 .. msc-tools documentation master file, created by
    sphinx-quickstart on Thu Mar 24 19:03:16 2011.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to msc-tools's documentation!
-=====================================
+.. include:: ./../README.rst
 
-**Tools**
+Tools
+=====
 
 .. toctree::
    :maxdepth: 1