Add README and some comments

[mapsector.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..32f5769
--- /dev/null
+++ b/README
@@ -0,0 +1,65 @@
+
+mapsector -- Map sector number to file name(s)
+
+Given a device and a sector number, mapsector will try to find the
+file name(s) mapping to this sector. It will try to gather as much
+information about the given sector as possible.
+
+At the time of writing this README, mapsector has support for the
+following mapping schemes:
+
+    RAID level 1
+    cryptsetup (luks and dmcrypt)
+    LVM (linear allocation scheme)
+    partition tables
+
+and the following filesystems:
+
+    ext2-4
+    reiserfs
+
+
+INSTALLATION
+============
+
+There are two ways to build mapsector:
+
+ - build a debian package
+ - generate a combined 'mapsectorsh' script
+
+The debian package will automatically install dependencies and
+'Suggests' all additional packages needed to detect all the known
+filesystems and mapping schemes.
+
+The 'mapsectorsh' script is a single self-contained file which may be
+copied easily to any target system to be used. You need to make sure,
+that 'awk', 'python' and 'dc' are available.
+
+
+Getting the source
+------------------
+
+The sourcecode is distributed via git:
+
+ $ git clone git://git.j32.de/mapsector.git
+
+
+Building a debian package
+-------------------------
+
+Make sure, you have 'fakeroot' and the debian package development
+tools installed, then issue
+
+ $ make deb
+
+The resulting debian package will be placed into the parent directory.
+
+
+Building 'mapsectorsh'
+----------------------
+
+Just type
+
+ $ make
+
+and copy the 'mapsectorsh' script wherever you need it.