summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKevin Bowen <kevin.bowen@gmail.com>2020-09-11 19:22:57 +0200
committerAndre Miranda <andreldm@xfce.org>2020-09-11 19:22:57 +0200
commitf3d857bc4c0b3ee26f2f2bf659b887a6f6c770e2 (patch)
tree677a89b6d3651cc247ad9f671738652ac9510944 /README.md
parent4e917c423142c6833a611e3c258a5f9bd3f17f49 (diff)
downloadxfce4-appfinder-f3d857bc4c0b3ee26f2f2bf659b887a6f6c770e2.tar.gz
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md56
1 files changed, 40 insertions, 16 deletions
diff --git a/README.md b/README.md
index 22395b8..3767ec9 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,50 @@
-## What is it?
+[![License](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://gitlab.xfce.org/xfce/xfce4-appfinder/COPYING)
-The xfce4-appfinder is a program that searches your file system for .desktop files, and displays a categorized list of all the GUI applications on your system.
+# xfce4-appfinder
+xfce4-appfinder(Application Finder) is a program to find and launch installed
+applications on your system, and quickly execute commands. It does this by
+searching your file system for ''.desktop'' files, and displays a categorized
+list of all the GUI applications on your system.
-## Installation
+----
-The file [`INSTALL`](INSTALL) contains generic installation instructions.
+### Homepage
+[xfce4-appfinder documentation](https://docs.xfce.org/xfce/xfce4-appfinder/start)
-## Debugging Support
+### Changelog
-xfce4-appfinder currently supports three different levels of debugging support,
-which can be setup using the configure flag `--enable-debug` (check the output
-of `configure --help`):
+See [NEWS](https://gitlab.xfce.org/xfce/xfce4-appfinder/-/blob/master/NEWS) for details on changes and fixes made in the current release.
-| Argument | Description |
-| ------- | ----------- |
-| `yes` | This is the default for Git snapshot builds. It adds all kinds of checks to the code, and is therefore likely to run slower. Use this for development of xfce4-appfinder and locating bugs in xfce4-appfinder. |
-| `minimum` | This is the default for release builds. **This is the recommended behaviour.** |
-| `no` | Disables all sanity checks. Don't use this unless you know exactly what you do. |
+### Source Code Repository
-## How to report bugs?
+[xfce4-appfinder source code](https://gitlab.xfce.org/xfce/xfce4-appfinder)
+
+### Download A Release Tarball
+
+[xfce4-appfinder archive](https://archive.xfce.org/src/xfce/xfce4-appfinder)
+ or
+[xfce4-appfinder tags](https://gitlab.xfce.org/xfce/xfce4-appfinder/-/tags)
+
+### Installation
+
+From source:
+
+ % cd xfce4-appfinder
+ % ./autogen.sh
+ % make
+ % make install
+
+From release tarball:
+
+ % tar xf xfce4-appfinder-<version>.tar.bz2
+ % cd xfce4-appfinder-<version>
+ % ./configure
+ % make
+ % make install
+
+### Reporting Bugs
+
+Visit the [reporting bugs](https://docs.xfce.org/xfce/xfce4-appfinder/bugs) page to view currently open bug reports and instructions on reporting new bugs or submitting bugfixes.
-Bugs should be reported to the [Xfce bug tracking system](https://bugzilla.xfce.org)
-against the product xfce4-appfinder. You will need to create an account for yourself.