[Xfce4-commits] [apps/catfish] 01/01: Improve installation instructions (bug #15105)

[noreply at xfce.org]

This is an automated email from the git hooks/post-receive script.

b   l   u   e   s   a   b   r   e       p   u   s   h   e   d       a       c   o   m   m   i   t       t   o       b   r   a   n   c   h       m   a   s   t   e   r   
   in repository apps/catfish.

commit e2eb6bb22de7eb0712f19a0087eb973258df6ab2
Author: Sean Davis <smd.seandavis at gmail.com>
Date:   Sat Sep 7 06:21:10 2019 -0400

    Improve installation instructions (bug #15105)
---
 INSTALL | 42 ++++++++++++++++++++++++++++++++++++------
 README  |  2 +-
 2 files changed, 37 insertions(+), 7 deletions(-)

diff --git a/INSTALL b/INSTALL
index 81647ef..ca7423a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,15 +1,45 @@
-To build Catfish, you need https://launchpad.net/python-distutils-extra
-Catfish can be used with Python 2 or 3.
+Requirements
+------------
+- Python (2 or 3)
+- Python Distutils Extra (https://launchpad.net/python-distutils-extra)
+- Python GLib / GObject bindings: GdkPixbuf, GLib, GTK 3, Pango, Cairo
+- Pexpect (https://pypi.org/project/pexpect/)
+- locate or mlocate
+
+To install the build and runtime requirements on a Debian-based system,
+the following command is sufficient:
+
+    sudo apt install python python-distutils-extra gir1.2-gdkpixbuf-2.0
+    gir1.2-glib-2.0 gir1.2-gtk-3.0 gir1.2-pango-1.0 python-gi-cairo
+    python-pexpect locate
+
+
+Optional
+--------
+Catfish includes optional support for Zeitgeist, which is used to provide
+instant search results. You can learn more about Zeitgeist here:
+
+    Homepage:  https://launchpad.net/zeitgeist-project
+    Arch Wiki: https://wiki.archlinux.org/index.php/Zeitgeist
+
+To enable Zeitgeist, just install the Python Zeitgeist binding and ensure
+the Zeitgeist datahub is running.
+
+    sudo apt install python-zeitgeist
+
+
+Install Instructions
+--------------------
 
 1.  Unpack the archive.
 
 2.  Install Catfish:
 
-2a. To install locally (a user install), run:
-	python setup.py install --user
+    2a. To install locally (a user install), run:
+        python setup.py install --user
 
-2b. To install system-wide (a root install), run:
-	(sudo) python setup.py install
+    2b. To install system-wide (a root install), run:
+        (sudo) python setup.py install
 
 3.  For a list of command line options run
       catfish --help
diff --git a/README b/README
index 698e264..1918949 100644
--- a/README
+++ b/README
@@ -24,7 +24,7 @@ Dependencies
 
 * Python 2 or 3
 * GLib / GObject Python bindings: GdkPixbuf, GLib, GTK 3, Pango, Cairo
-* Pexpect
+* [Pexpect](https://pypi.org/project/pexpect/)
 * locate or mlocate
 
 Installation and Bugs

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.