Add Readme

This commit is contained in:
Smasty 2018-02-01 22:13:01 +01:00
parent 661eec174e
commit 9369b53534
No known key found for this signature in database
GPG Key ID: 9F7DB39EC36B10EA

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# Logitech G203 Prodigy LED Control
Allows you to control the LED lighting of your G203 programmatically.
Inspired by and based on [g810-led](https://github.com/MatMoul/g810-led)
## Requirements
- Python 3.5+
- PyUSB 1.0.2+
- *Root privileges*
## Installation
1) Clone the repository: `git clone https://github.com/smasty/g203-led.git`
2) Install dependencies: `pip install -r requirements.txt`
3) Run (as root): `sudo ./g203-led.py solid 00FFFF`
## Usage
```
Usage:
g203-led solid {color} - Solid color mode
g203-led cycle [{rate} [{brightness}]] - Cycle through all colors
g203-led breathe {color} [{rate} [{brightness}]] - Single color breathing
Arguments:
Color: RRGGBB (RGB hex value)
Rate: 100-60000 (Number of milliseconds. Default: 10000ms)
Brightness: 0-100 (Percentage. Default: 100%)""")
```