aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-04-04 18:54:54 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-04-04 18:54:54 +0000
commitf4e6d2e3ee0c89c57a9dde46aa1049a2ec6999d7 (patch)
tree88d95bf09d25b1267a085e2ce69d8777c36a56e3
parentdoc: foot.1: list what a bug report should contain (diff)
README: describe how to report bugs
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9efa889c..26b9a482 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,7 @@
1. [Installing](#installing)
1. [Arch Linux](#arch-linux)
1. [Other](#other)
+1. [Bugs](#bugs)
## Features
@@ -397,3 +398,17 @@ just install everything:
```sh
ninja install
```
+
+
+# BUGS
+
+Please report bugs to https://codeberg.org/dnkl/foot/issues
+
+The report should contain the following:
+
+* Which Wayland compositor (and version) you are running
+* Foot version (`foot --version`)
+* Log output from foot (start foot from another terminal)
+* If reporting a crash, please try to provide a `bt full` backtrace
+ with symbols
+* Steps to reproduce. The more details the better