From 6090a63017a7503953d1ba8db9ca3b4da7286f79 Mon Sep 17 00:00:00 2001
From: "Francois B. (Makoto)" <francois@makotonoblog.be>
Date: Mon, 19 Oct 2020 17:05:14 +0200
Subject: [PATCH] add comments, readme, ...

---
 README.md             | 48 +++++++++++++++++++++++++++++++++++++++----
 quodlibetLCDScreen.py |  2 +-
 2 files changed, 45 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index a0d38bf..e587445 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,47 @@
-About
------
+quodlibetLCDScreen
+------------------
 
-todo
+This is a little plugin for Quod Libet audio player that allow you to display current song Artist/Title on an external USB LCD Screen.
+
+Hardware compatibility
+----------------------
+
+I used this screen :  https://www.banggood.com/1602-RGB-LCD-Display-With-USB-Port-For-Raspberry-Pi-3B-2B-B-Windows-Linux-p-1079617.html?rmmds=myorder&cur_warehouse=CN
+
+Dependencies
+------------
+
+- lcd2usb : https://github.com/xyb/lcd2usb
+- quodlibet libs
+- getpass
+- GTK libs
+
+Manual install
+--------------
+
+On Ubuntu :
+
+- Create a directory named `quodlibetLCDScreen` in `~/.quodlibet/plugins`
+- Copy `quodlibetLCDScreen.py` in this directory
+- Open Quodlibet and activate the plugin, you should see a `Hello <your_username>` on the screen
+
+Udev rules
+----------
+
+- On Ubuntu, add this rules in `/etc/udev/rules.d/51-lcd2usb.rules`
+
+```shell scriptll
+# Find your device information with command "lsusb"
+# Change ATTR{idVendor} and ATTR{idProduct} to match.
+#
+# In my case : Bus 006 Device 002: ID 0403:c630 Future Technology Devices International, Ltd lcd2usb interface
+#
+# This allows users to access the usb device without requiring root permissions
+#
+SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTR{idVendor}=="0403", ATTR{idProduct}=="c630", MODE="0666"
+```
+
+- Then reboot computer or refresh udev : `sudo udevadm control --reload-rules`
 
 Credits
 -------
@@ -9,7 +49,7 @@ Credits
 This script has been written by Francois B. (Makotosan)
 
 * Email : francois@makotonoblog.be
-* Website : https://makotonoblog.be/quodlibetLCDScreen/
+* Website : https://makotonoblog.be/
 
 Licence
 -------
diff --git a/quodlibetLCDScreen.py b/quodlibetLCDScreen.py
index 967acbd..a194992 100644
--- a/quodlibetLCDScreen.py
+++ b/quodlibetLCDScreen.py
@@ -2,7 +2,7 @@
 quodlibetLCDScreen
     author : Francois B. (Makotosan/Shakasan)
     licence : GPLv3
-    website : https://makotonoblog.be/quodlibetLCDScreen
+    website : https://makotonoblog.be/
 """
 
 import os