From 771d090c1838dfdb84767b7233dbeafa0cfda9cd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Mon, 20 Jul 2020 17:37:52 +0200
Subject: [PATCH] readme: add a 'bugs' section, describing how to report bugs

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 1018ff2..beb2b17 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@
 1. [Introduction](#introduction)
 1. [Configuration](#configuration)
 1. [Modules](#modules)
+1. [Installation](#installation)
+1. [Bugs](#bugs)
 
 
 ## Introduction
@@ -112,3 +114,16 @@ Optionally, install it:
 ```sh
 ninja install
 ```
+
+## Bugs
+
+Please report bugs to https://codeberg.org/dnkl/yambar/issues
+
+The report should contain the following:
+
+* Which Wayland compositor (and version) you are running
+* Yambar version (`yambar --version`)
+* Log output from yambar (start yambar from a terminal)
+* If reporting a crash, please try to provide a `bt full` backtrace
+  **with symbols** (i.e. use a debug build)
+* Steps to reproduce. The more details the better