summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndre Miranda <andreldm@xfce.org>2020-05-18 13:20:11 -0300
committerAndre Miranda <andreldm@xfce.org>2020-05-18 13:20:11 -0300
commit0ea388600a01a5c4af6315cf4faef95ed75c12da (patch)
tree68245310d9bfa010543072c24d0683150a08fd23 /README.md
parentbfb09aba90368ef30b93e6d33ff33fc580776b06 (diff)
downloadxfce4-appfinder-0ea388600a01a5c4af6315cf4faef95ed75c12da.tar.gz
Switch to README.md and foreign automake mode
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..22395b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+## What is it?
+
+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.
+
+
+## Installation
+
+The file [`INSTALL`](INSTALL) contains generic installation instructions.
+
+
+## Debugging Support
+
+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`):
+
+| 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. |
+
+## How to report bugs?
+
+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.