From 5896d1a14daec4c58b86bcd74e6f64acb6a63004 Mon Sep 17 00:00:00 2001
From: "ay9thqi3tbqiwbegqsg a[soiaosshasdg"
 <30902201+alx365@users.noreply.github.com>
Date: Thu, 22 Oct 2020 16:31:39 +0000
Subject: [PATCH] added troubleshooting to the readme (and fixed a small naming
 convention issue) (#39)

---
 README.md                         | 21 ++++++++++++++++++++-
 src/widgets/widget_definitions.rs |  2 +-
 2 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ced413e..700dd3a 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@
    -  [Prerequisites](#org727b3da)
    -  [Installation](#orgdd31739)
 -  [Usage](#org4a9b3c6)
+-  [Troubleshooting](#something)
 -  [Contributing](#org12345)
 
 <a id="org4ab08b6"></a>
@@ -91,6 +92,24 @@ then copy the built binary from `./target/release` to anywhere in `$PATH` (examp
 
 Create a Config and then just do `eww`!
 
+<a id="something"></a>
+
+# Troubleshooting
+
+If you experience any issues, the following things should be tried:
+
+- Try killing the eww daemon with `eww kill` and run again
+- If you're running with `-d`, run without `-d` to see output, or have a look at ~/.cache/eww.log 
+- use `eww state`, to see the state of all variables
+- use `eww debug`, to see the xml of your widget and other information
+- update to the latest eww version
+- sometimes hot reloading doesn't work. restart the widget in that case
+
+If you're experiencing issues printing variables, try to print them in quotes, so e.g.
+```
+onchange="notify-send '{}'"
+```
+
 <a id="org12345"></a>
 
 # Contributing
@@ -100,5 +119,5 @@ If you want to contribute, like adding new widgets, features or subcommands, you
 ## Steps
 1. Fork this repo
 2. install dependencies ([Prerequisites](#org727b3da))
-3. smash your head against the keyboard
+3. smash your head against the keyboard from frustration (coding is hard)
 4. open a pull request once you're finished.
diff --git a/src/widgets/widget_definitions.rs b/src/widgets/widget_definitions.rs
index f056697..4fa6b92 100644
--- a/src/widgets/widget_definitions.rs
+++ b/src/widgets/widget_definitions.rs
@@ -157,7 +157,7 @@ fn build_gtk_expander(bargs: &mut BuilderArgs) -> Result<gtk::Expander> {
     });
     Ok(gtk_widget)
 }
-/// @widget color button
+/// @widget color-button
 fn build_gtk_color_button(bargs: &mut BuilderArgs) -> Result<gtk::ColorButton> {
     let gtk_widget = gtk::ColorButtonBuilder::new().build();
     let on_change_handler_id: Rc<RefCell<Option<glib::SignalHandlerId>>> = Rc::new(RefCell::new(None));