about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2013-04-03 23:35:36 +0000
committerEric Wong <normalperson@yhbt.net>2013-04-03 23:35:36 +0000
commitec0b5b656e6cad27a70d1e0dac8ca8ecfa203e4e (patch)
tree9aa84edbb4bc8e61dac00fb5c3568cfba3606d71
parent946991ce2a7cab1430facbd00fe924c8041c34ae (diff)
downloadmahoro-ec0b5b656e6cad27a70d1e0dac8ca8ecfa203e4e.tar.gz
INSTALL: improve documentation for deb/rpm-based distros
This should make it easier to install mahoro.
-rw-r--r--INSTALL26
1 files changed, 24 insertions, 2 deletions
diff --git a/INSTALL b/INSTALL
index 0f9c7af..8e8875a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,27 @@
- INSTALL
-=========
+libmagic installation
+=====================
+
+Mahoro is a wrapper around libmagic[1], so it needs the libmagic
+development headers and libraries to run.  If your operating system
+provides libmagic development libraries and headers, you will not need
+the "--with-magic*" command-line options below.
+
+For Debian-based systems: apt-get install libmagic-dev
+For CentOS 6.x or similar RPM-based systems: yum install file-devel
+For CentOS 5.x or similar RPM-based systems: yum install file
+
+[1] - https://en.wikipedia.org/wiki/Libmagic
+
+INSTALL (from RubyGems)
+=======================
+
+The installation is simple, install libmagic and type the following:
+
+# gem install mahoro -- --with-magic-include=/path/to/include \
+                        --with-magic-lib=/path/to/lib
+
+INSTALL (from tarball)
+======================
 
 The installation is simple, install libmagic and type the following.