add setup, install & run sections

This commit is contained in:
2025-08-02 12:53:58 +02:00
parent d6c68495ad
commit 4d0fdb5746

View File

@@ -1,2 +1,51 @@
# keyboard-dashboard-autostart
Listens for keyboard events on function keys to launch programs
## Run
```bash
python3 main.py
```
### Options
```bash
python3 main.py --help
Available key bindings:
F16: openBrowser()
F17: openTerminal('watch -n 1 "sensors | grep temp1"')
```
## Configure environment
Bash:
```bash
virtualenv env
source env/bin/activate
```
Fish:
```bash
virtualenv env
source env/bin/activate.fish
```
## Requirements
Install system packages:
```bash
(sudo) apt install jq xdotool
```
Install python dependencies:
```bash
pip3 install -r requirements.txt
```