2021-01-05 07:12:27 -05:00
|
|
|
### vial-gui
|
2020-10-14 22:28:18 -04:00
|
|
|
|
2021-01-05 07:12:27 -05:00
|
|
|
# Docs and getting started
|
|
|
|
|
|
2021-02-16 13:18:22 -05:00
|
|
|
### Please visit [get.vial.today](https://get.vial.today/) to get started with Vial
|
2021-01-05 07:12:27 -05:00
|
|
|
|
2021-07-11 19:25:28 -04:00
|
|
|
Vial is an open-source cross-platform (Windows, Linux and Mac) GUI and a QMK fork for configuring your keyboard in real time.
|
2021-01-05 07:12:27 -05:00
|
|
|
|
|
|
|
|
|
2021-02-16 13:18:22 -05:00
|
|
|
|
2021-01-05 07:12:27 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Releases
|
2020-10-14 22:28:18 -04:00
|
|
|
|
2021-02-16 13:18:22 -05:00
|
|
|
Visit https://get.vial.today/ to download a binary release of Vial.
|
2020-10-14 22:28:18 -04:00
|
|
|
|
2021-01-05 07:12:27 -05:00
|
|
|
#### Development
|
2020-10-14 22:28:18 -04:00
|
|
|
|
|
|
|
|
Python 3.6 is recommended (3.6 is the latest version that is officially supported by `fbs`).
|
|
|
|
|
|
|
|
|
|
Install dependencies:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
python3 -m venv venv
|
|
|
|
|
source venv/bin/activate
|
|
|
|
|
pip install -r requirements.txt
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To launch the application afterwards:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
source venv/bin/activate
|
|
|
|
|
fbs run
|
|
|
|
|
```
|
