Add README

main
Ilya Zhuravlev 2020-10-14 22:28:18 -04:00
parent b61a7385e3
commit e6e35607d3
1 changed files with 24 additions and 0 deletions

24
README.md 100644
View File

@ -0,0 +1,24 @@
# vial-gui
## Releases
Currently, no releases are provided. You can download a precompiled binary from latest GitHub Action: https://github.com/vial-kb/vial-gui/actions (need to log into a github account).
## Development
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
```