mirror of
https://github.com/KevinMidboe/keyboard-dashboard-autostart.git
synced 2025-10-29 09:40:17 +00:00
add setup, install & run sections
This commit is contained in:
49
README.md
49
README.md
@@ -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
|
||||
```
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user