diff --git a/README.md b/README.md index b5db464..a39181f 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ This program allows the user to adjust color and brightness to the various LEDs found throughout the DualSense (DS). Rainbow, disco, or otherwise random effects can be applied, though these are unstable. Also fetches battery percentage and displays this. ## Prerequisites (besides your DS, obviously) -* Linux-based operating system -* Access to root privileges (the program modifies the values found in `/sys/devices`) +* Linux-based operating system with kernel 5.12 or later +* Access to root privileges (the program modifies the values found in `/sys/devices/pci0000:00/(long string followed by a bunch of folders/`) * Python 3 * GTK 3 * Tkinter @@ -14,7 +14,7 @@ The program is highly unstable depending on what button you press, in particular * Rainbow LED colors * Disco/Progress bar LED patterns -Pressing any of those types of buttons (which have been labeled as unstable accordingly) will cause the program to loop indefinitely. You'll need to one of the following: +Clicking any of those buttons (which have been labeled as unstable accordingly) will cause the program to loop indefinitely. You'll need to one of the following: * Press `Enter` in the terminal window to either close the application or keep it from looping * force exit the application through your system monitor * disconnect your DS @@ -22,16 +22,14 @@ Pressing any of those types of buttons (which have been labeled as unstable acco Other tasks going on on your computer will still run regardless. ## How To Use -1. Clone the repository, i.e. `git clone https://github.com/cow-killer/dualsense-led-configurator.git` -2. Run the script as root: `sudo python ds_led.py` +1. Clone the repository:
+`git clone https://github.com/cow-killer/dualsense-led-configurator.git` +2. Change into the `dualsense-led-configurator` folder and run the script as root:
+`sudo python ds_led.py` ## To-Do -* ~~Code is a mess, more than likely a way to reduce the amount of code needed~~ Thanks thats-the-joke! * Much-needed UI polish * Find a way to get rainbow LEDs, disco, etc. to work without hanging the application -**Update 2/13/2021:** only Rainbow needs to get fixed now -* ~~Add a color picker~~ -* Add a way to extract MAC address without user interaction * Update UI if controller is plugged/unplugged and if the percentage of the battery has changed Pull requests welcomed!