[Xfce4-commits] [apps/catfish] 01/01: Improve included documentation

[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 a9eb54c21eafc87239f64e618ff39a76eff53e43
Author: Sean Davis <smd.seandavis at gmail.com>
Date:   Sun Jul 8 18:28:30 2018 -0400

    Improve included documentation
---
 .gitignore     |  3 +++
 HACKING        |  2 ++
 INSTALL        | 23 +++++++++++------------
 README         | 29 ++++++++++++++++++++---------
 TODO           |  8 --------
 catfish.1      |  2 +-
 po/catfish.pot |  2 +-
 7 files changed, 38 insertions(+), 31 deletions(-)

diff --git a/.gitignore b/.gitignore
index 0101bf5..16e88fd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,6 @@
 build/
 __pycache__
 *~
+*.pyc
+MANIFEST
+dist/
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..c09846c
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,2 @@
+To edit the .ui files, run the following command:
+	GLADE_CATALOG_SEARCH_PATH=./data/ui glade ./data/ui/*.ui
\ No newline at end of file
diff --git a/INSTALL b/INSTALL
index f6ff142..81647ef 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,16 +1,15 @@
-1. Unpack the archive.
+To build Catfish, you need https://launchpad.net/python-distutils-extra
+Catfish can be used with Python 2 or 3.
 
-2. To build catfish run 
-      ./configure
-      make
+1.  Unpack the archive.
 
-3. To install catfish run either
-      (sudo) make install
-   or
-      (sudo) checkinstall
+2.  Install Catfish:
 
-4. For a list of command line options run
-      catfish --help
+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
 
-5. To create a distributable package of catfish run
-      make deb
\ No newline at end of file
+3.  For a list of command line options run
+      catfish --help
diff --git a/README b/README
index acb6c30..4e732b2 100644
--- a/README
+++ b/README
@@ -1,14 +1,25 @@
-Catfish is a handy file searching tool for linux and unix. The interface is intentionally lightweight and simple, using only GTK+3. You can configure it to your needs by using several command line options.
+Catfish is a handy file searching tool for linux and unix.
+The interface is intentionally lightweight and simple, using only GTK+3.
+You can configure it to your needs by using several command line options.
 
-Dependencies: python-gi, gksu, python-pexpect, locate | mlocate
+Dependencies:
+- Python 2 or 3
+- GLib / GObject Python bindings: GdkPixbuf, GLib, GTK 3, Pango, Cairo
+- Pexpect
+- locate or mlocate
 
-For installation instructions read INSTALL.
+For installation instructions, please read INSTALL.
 
-You are encouraged to run 'catfish --help' to check out the various command line options.
+You are encouraged to run 'catfish --help' to check out the various
+command line options.
 
-Please report comments, suggestions and bugs to:
-    Christian Dywan <christian at twotoasts.de>
-    Sean Davis <smd.seandavis at gmail.com>
+Catfish is part of the Xfce project. All project resources can be found
+at the following locations:
 
-Check for new versions at:
-    www.twotoasts.de
+Homepage: https://docs.xfce.org/apps/catfish/start
+Bugs: http://bugzilla.xfce.org/buglist.cgi?product=Catfish
+VCS: https://git.xfce.org/apps/catfish
+Translations: https://www.transifex.com/xfce/public
+
+Please send all bugs, suggestions, and feature requests to the Xfce Bugzilla:
+http://bugzilla.xfce.org/buglist.cgi?product=Catfish
diff --git a/TODO b/TODO
deleted file mode 100644
index b0d54cb..0000000
--- a/TODO
+++ /dev/null
@@ -1,8 +0,0 @@
-Planned Features:
-* Rename widgets for autopilot, including GtkWindow to CatfishWindow
-* Add support for Tracker
-* Allow editing of search methods used (locate, find, python-walk)
-
-Other:
-* Improve glade editing. To edit the UI files, launch glade with:
-  'GLADE_CATALOG_SEARCH_PATH=./data/ui glade ./data/ui/*.ui'
diff --git a/catfish.1 b/catfish.1
index f82da9c..c4b9b9b 100644
--- a/catfish.1
+++ b/catfish.1
@@ -1,4 +1,4 @@
-.TH CATFISH "1" "April 2018" "catfish 1.4.5" "User Commands"
+.TH CATFISH "1" "July 2018" "catfish 1.4.6" "User Commands"
 .SH NAME
 catfish \- File searching tool which is configurable via the command line
 .SH "DESCRIPTION"
diff --git a/po/catfish.pot b/po/catfish.pot
index 1a41276..04ad17d 100644
--- a/po/catfish.pot
+++ b/po/catfish.pot
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2018-07-08 13:58-0400\n"
+"POT-Creation-Date: 2018-07-08 17:55-0400\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL at ADDRESS>\n"
 "Language-Team: LANGUAGE <LL at li.org>\n"

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