diff --git a/README.md b/README.md new file mode 100644 index 0000000..d469f02 --- /dev/null +++ b/README.md @@ -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 +```