doc upd

README.md

@@ -1,29 +1,25 @@
-quodlibetLCDScreen
-------------------
+# quodlibetLCDScreen
 
 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.
 
 ![screen1](lcd.jpg)
 
-Hardware compatibility
-----------------------
+## 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
+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>
 
-Dependencies
-------------
+## Dependencies
 
-- lcd2usb : https://github.com/xyb/lcd2usb
+- lcd2usb : <https://github.com/xyb/lcd2usb>
 - quodlibet libs
 - getpass
 - GTK libs
 
-Udev rules
-----------
+## Udev rules
 
 - On Ubuntu, add this rule in `/etc/udev/rules.d/51-lcd2usb.rules`
 
-```shell scriptll
+```shell
 # Find your device information with command "lsusb"
 # Change ATTR{idVendor} and ATTR{idProduct} to match.
 #
@@ -36,31 +32,27 @@ SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTR{idVendor}=="0403", ATTR{idPro
 
 - Then reboot computer or refresh udev : `sudo udevadm control --reload-rules`
 
-Manual install
---------------
+## Manual install
 
-On Ubuntu :
+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
 
-Screenshots
------------
+## Screenshots
 
 ![screen1](screen_1.jpeg)
 
 ![screen1](screen_2.jpeg)
 
-Credits
--------
+## Credits
 
 This script has been written by Francois B. (Makotosan)
 
-* Email : francois@makotonoblog.be
-* Website : https://makotonoblog.be/quodlibetlcdscreen
+- Email : <francois@makotonoblog.be>
+- Website : <https://makotonoblog.be/applications/quodlibetlcdscreen/>
 
-Licence
--------
+## Licence
 
-The script/plugin is licensed under the terms of the GPLv3
+- The script/plugin is licensed under the terms of the GPLv3