From 1f0f39394fdcfd3f39d1bcfeff9bdd6a91dc679d Mon Sep 17 00:00:00 2001 From: Tobias Witek Date: Sun, 2 Apr 2017 08:34:17 +0200 Subject: [PATCH] [doc] Add documentation for debug mode --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c5749cb..7b64b77 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ $ git clone git://github.com/tobi-wan-kenobi/bumblebee-status ``` # Usage - +## Normal usage Next, open your i3wm configuration and modify the *status_command* for your i3bar like this: ``` @@ -68,9 +68,17 @@ bar { ``` - Restart i3wm and - that's it! +## Errors +If errors occur, you should see them in the i3bar itself. If that does not work, or you need more information for troubleshooting, you can activate a debug log using the `-d` or `--debug` switch: + +``` +$ ./bumblebee-status -d -m +``` + +This will create a file called `debug.log` in the same directory as the executable `bumblebee-status`. + # Required Modules Modules and commandline utilities are only required for modules, the core itself has no external dependencies at all.