ISSUE_TEMPLATE.md

   1 # Please, read me!
   2
   3 So that I can help you quickly and without having to redirect you here.
   4
   5 # If you have an issue
   6
   7 **Please read the [wiki](https://github.com/lcpz/lain/wiki) and search the [Issues section](https://github.com/lcpz/lain/issues) first.**
   8
   9 If you can't find a solution there, then go ahead and provide:
  10
  11 * output of `awesome -v` and `lua -v`
  12 * expected behavior and actual behavior
  13 * steps to reproduce the problem
  14 * X error log
  15
  16 # How to provide X error log
  17
  18 There are two ways:
  19
  20 * (Physically) Restart X like this:
  21   ```shell
  22   startx -- -keeptty -nolisten tcp > $HOME/.xorg.log 2>&1
  23   ```
  24   the error log will be output into `$HOME/.xorg.log`.
  25
  26 * (Virtually) Use [Xephyr](https://wikipedia.org/wiki/Xephyr):
  27   ```shell
  28   # set screen size as you like
  29   Xephyr :1 -screen 1280x800 2> stdout.txt & DISPLAY=:1 awesome
  30   ```
  31   the error log will be output in the file `stdout.txt`.
  32
  33 Before reporting, read the log and see if you can solve it yourself.